Difference between revisions of "TAG()"
Helengeorge (Talk | contribs) (→Class) |
Yvonnemilne (Talk | contribs) |
||
| (2 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | |||
| − | |||
==Purpose== | ==Purpose== | ||
Function to return the name of an index file or index tag | Function to return the name of an index file or index tag | ||
| Line 6: | Line 4: | ||
==Syntax== | ==Syntax== | ||
| − | TAG([<.dbx filename>,] [<expN> [,<alias>]]) | + | TAG([<.dbx filename>,] [<expN> [, <alias>]]) |
| Line 14: | Line 12: | ||
==Description== | ==Description== | ||
| − | The TAG() function returns the tag name of the specified .dbx file, or the filename of a single (.ndx) file. With no parameters, the TAG() function operates in the current workarea on the master index. If no indexes are active, TAG() will return a null string. An error will be given if an invalid alias name is given. | + | The TAG() function returns the tag name of the specified .dbx file, or the filename of a single (.ndx) file. With no parameters, the TAG() function operates in the current workarea on the master index. If the optional <.dbx filename> is not specified, one of its tags must be the master index order for its tag names to be queried. If no indexes are active or the specified index is not active, TAG() will return a null string. An error will be given if an invalid alias name is given. |
| Line 25: | Line 23: | ||
|- | |- | ||
|<alias>||The workarea in which to operate. Specified in any of the following ways: | |<alias>||The workarea in which to operate. Specified in any of the following ways: | ||
| − | A workarea number | + | A workarea number. |
A workarea letter: A-Z (a-z) excluding M (m). | A workarea letter: A-Z (a-z) excluding M (m). | ||
A table alias. The alias can be specified in the USE command. If not specified, the table basename is used. | A table alias. The alias can be specified in the USE command. If not specified, the table basename is used. | ||
|- | |- | ||
|} | |} | ||
| − | |||
| Line 43: | Line 40: | ||
==Products== | ==Products== | ||
| − | Recital | + | Recital, Recital Server |
[[Category:Documentation]] | [[Category:Documentation]] | ||
[[Category:Functions]] | [[Category:Functions]] | ||
[[Category:Indexing]] | [[Category:Indexing]] | ||
[[Category:Indexing Functions]] | [[Category:Indexing Functions]] | ||
Latest revision as of 13:38, 7 January 2010
Purpose
Function to return the name of an index file or index tag
Syntax
TAG([<.dbx filename>,] [<expN> [, <alias>]])
See Also
DBF(), KEY(), MDX(), NDX(), ORDER(), TAGCOUNT(), TAGNO()
Description
The TAG() function returns the tag name of the specified .dbx file, or the filename of a single (.ndx) file. With no parameters, the TAG() function operates in the current workarea on the master index. If the optional <.dbx filename> is not specified, one of its tags must be the master index order for its tag names to be queried. If no indexes are active or the specified index is not active, TAG() will return a null string. An error will be given if an invalid alias name is given.
| Parameter | Description |
|---|---|
| <.dbx filename> | The .dbx file which contains the tag |
| <expN> | The number of the tag |
| <alias> | The workarea in which to operate. Specified in any of the following ways:
A workarea number. A workarea letter: A-Z (a-z) excluding M (m). A table alias. The alias can be specified in the USE command. If not specified, the table basename is used. |
Example
?tag(2) LAST_NAME tag("alternate.dbx",3) ZIPCODE
Products
Recital, Recital Server
