Click or drag to resize

ATagInfo Function

X#
-- todo --
Creates an array that contains information about index files for the selected table.

Namespace:  XSharp.VFP
Assembly:  XSharp.VFP (in XSharp.VFP.dll) Version: 2.21
Syntax
 FUNCTION ATagInfo(
	ArrayName,
	cCDXName,
	uArea
) AS USUAL CLIPPER
Request Example View Source

Parameters

ArrayName (Optional)
Type: Usual
Specifies the name of the array to create. X# creates the array if it does not already exist.
cCDXName (Optional)
Type: Usual
Specifies the name of the compound index (.cdx) file to return information for. Specifying an empty string ("") returns the number of tags in all open .cdx files and all open standalone index (.idx) files for the selected table.
uArea (Optional)
Type: Usual
Specifies the work area number or workarea alias that contains the table to returns information for.
Omitting this uses the table in the current work area.

Return Value

Type: Usual
Numeric. ATagInfo( ) returns the number of index tags in compound index (.cdx) files or open single-key standalone index (.idx) files for the current table.
Remarks
The following table describes the information stored in the array that ATagInfo( ) creates.
ColumnDescriptionData type
1Index tag name in a .cdx file or index file name for .idx filesCharacter
2Index tag typeCharacter
3Index key expressionCharacter
4Filter expressionCharacter
5Index order as created (Ascending or Descending)Character
6Collate sequenceCharacter
See Also