Difference between revisions of "FOR()"

From Lianjapedia
Jump to: navigation, search
m (1 revision)
 
(One intermediate revision by one other user not shown)
Line 1: Line 1:
 
==Purpose==
 
==Purpose==
 
Function to return the FOR condition that was used to create an index tag
 
Function to return the FOR condition that was used to create an index tag
 
  
 
==Syntax==
 
==Syntax==
 
FOR([[<.dbx filename>,] <expN> [,<alias>]])
 
FOR([[<.dbx filename>,] <expN> [,<alias>]])
 
  
 
==See Also==
 
==See Also==
 
[[DESCENDING()]], [[INDEX]], [[KEY()]], [[MDX()]], [[ORDER()]], [[SET INDEX]], [[TAG()]], [[TAGCOUNT()]], [[TAGNO()]], [[UNIQUE()]]
 
[[DESCENDING()]], [[INDEX]], [[KEY()]], [[MDX()]], [[ORDER()]], [[SET INDEX]], [[TAG()]], [[TAGCOUNT()]], [[TAGNO()]], [[UNIQUE()]]
 
  
 
==Description==
 
==Description==
Line 15: Line 12:
 
The optional <.dbx filename> causes the FOR() function to check the specified .dbx file for the tag specified by the tag number <expN>.  You may specify a character expression that returns the name of a valid multiple index file.  If no multiple index filename is specified, the FOR() function checks the currently open multiple index file.  If no multiple index file is open, the FOR() function returns a null string.  
 
The optional <.dbx filename> causes the FOR() function to check the specified .dbx file for the tag specified by the tag number <expN>.  You may specify a character expression that returns the name of a valid multiple index file.  If no multiple index filename is specified, the FOR() function checks the currently open multiple index file.  If no multiple index file is open, the FOR() function returns a null string.  
 
You may optionally specify an alias name to use the FOR() function in other workareas.  The <alias> may be a workarea number, an alias name which has been created with the USE command, or A through T, excluding M.  If no alias name is specified, the FOR() function looks in the currently active workarea.
 
You may optionally specify an alias name to use the FOR() function in other workareas.  The <alias> may be a workarea number, an alias name which has been created with the USE command, or A through T, excluding M.  If no alias name is specified, the FOR() function looks in the currently active workarea.
 
  
 
==Example==
 
==Example==
Line 23: Line 19:
 
acct = "CAR"
 
acct = "CAR"
 
</code>
 
</code>
 
+
 
+
==Products==
+
Recital Server, Recital
+
 
[[Category:Documentation]]
 
[[Category:Documentation]]
 
[[Category:Functions]]
 
[[Category:Functions]]
[[Category:Indexing]]
+
[[Category:Cursor Functions]]
[[Category:Indexing Functions]]
+
[[Category:Search Functions]]

Latest revision as of 11:08, 4 February 2013

Purpose

Function to return the FOR condition that was used to create an index tag

Syntax

FOR([[<.dbx filename>,] <expN> [,<alias>]])

See Also

DESCENDING(), INDEX, KEY(), MDX(), ORDER(), SET INDEX, TAG(), TAGCOUNT(), TAGNO(), UNIQUE()

Description

The FOR() function returns the FOR condition which was used to create an index tag. If the tag was not created with a FOR condition, or does not exist, the FOR() function returns a null string. With no parameters, the FOR() function operates in the current workarea on the master index. The optional <.dbx filename> causes the FOR() function to check the specified .dbx file for the tag specified by the tag number <expN>. You may specify a character expression that returns the name of a valid multiple index file. If no multiple index filename is specified, the FOR() function checks the currently open multiple index file. If no multiple index file is open, the FOR() function returns a null string. You may optionally specify an alias name to use the FOR() function in other workareas. The <alias> may be a workarea number, an alias name which has been created with the USE command, or A through T, excluding M. If no alias name is specified, the FOR() function looks in the currently active workarea.

Example

set view to accounting
? for(3)
acct = "CAR"