Partager via

ATAGINFO( ) Function

  • Article

Creates an array that contains information about index files for the selected table.

ATAGINFO(ArrayName [,cCDXName [, nWorkArea | cTableAlias]])

Parameters

  • ArrayName
    Specifies the name of the array to create. Visual FoxPro creates the array if it does not already exist.

  • cCDXName
    Specifies the name of the compound index (.cdx) file to return information for.

    Note

    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.

  • nWorkArea
    Specifies the work area that contains the table to returns information for.

  • cTableAlias
    Specifies the alias of the table to return information for.

    Note

    Omitting cTableAlias and nWorkArea uses the table in the current work area.

Return Value

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.

Column

Description

Data type

1

Index tag name in a .cdx file or index file name for .idx files

Character

2

Index tag type

Character

3

Index key expression

Character

4

Filter expression

Character

5

Index order as created (Ascending or Descending)

Character

6

Collate sequence

Character

See Also

Reference

TAG( ) Function

TAGCOUNT( ) Function

TAGNO( ) Function

Tag Property (Visual FoxPro)

Other Resources

Working with Table Indexes

Functions