Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Creates an array that contains information about the names, number, and types of indexes and key expressions.
ATagInfo(ArrayName, ,cCDXName [, nWorkArea | cTableAlias])
Parameters
- ArrayName
Specifies the name of the array to be created. Visual FoxPro creates the array if it does not already exist. - cCDXName
Specifies the name of the compound index file for which ATAGINFO( ) returns information. If you specify the empty string ("") for cCDXName, ATAGINFO( ) returns the number of tags in all open .cdx files and all open .idx files for the selected table. - nWorkArea
Optional. Specifies the work area containing the table for which ATAGINFO( ) returns information. - cTableAlias
Optional. Specifies the alias of the table for which ATAGINFO( ) returns information. If you omit cTableAlias and nWorkArea the function uses the table in the current workarea.
Return Value
Numeric
Remarks
AtagInfo( ) returns the number of .cdx compound index file tags and open .idx single-entry index files, and creates an array containing the tag name, tag Type (Primary/Candidate/Unique/Regular), the Key expression, filter, and order.
| Column | Content | Data type |
|---|---|---|
| 1 | Tag name (.idx name, if open) | Character |
| 2 | Tag type (Primary, Candidate, Unique, or Regular | Character |
| 3 | Key expression | Character |
| 4 | Filter | Character |
| 5 | Order (Ascending or Descending) | Character |
| 6 | Collate sequence | Character |
See Also
TAG( ) Function | TAGCOUNT( ) Function | TAGNO( ) Function | Tag Property