Difference between revisions of "TAG()"

From Recital Documentation Wiki
Jump to: navigation, search
(Class)
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 43: Line 41:
  
 
==Products==
 
==Products==
Recital Database Server, Recital Mirage Server, Recital Terminal Developer
+
Recital, Recital Server
 
[[Category:Documentation]]
 
[[Category:Documentation]]
 
[[Category:Functions]]
 
[[Category:Functions]]
 
[[Category:Indexing]]
 
[[Category:Indexing]]
 
[[Category:Indexing Functions]]
 
[[Category:Indexing Functions]]

Revision as of 16:31, 8 December 2009

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 no indexes are 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: 1-DB_MAXWKA 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