AdsGetIndexHandle

Advantage Client Engine

  This is the first topic This is the last topic  

Retrieves the handle of an index order given the index order name.

Syntax

UNSIGNED32

AdsGetIndexHandle (ADSHANDLE hTable,

UNSIGNED8 *pucIndexOrder,

ADSHANDLE *phIndex);

Parameters

hTable (I)

Handle of table or cursor.

pucIndexOrder (I)

Name of index order for which to search.

phIndex (O)

Return index order handle corresponding to given name.

Special Return Codes

AE_INVALID_INDEX_ORDER_NAME

The index order name given is invalid.

Remarks

For non-compound indexes, the index order name is the base of the filename (up to 8 characters). For compound indexes, the index order name is the tag name (up to 10 characters).

If there is more than one index order open with the same name, the Advantage Client Engine will return the first one it finds.

Example

Click Here

See Also

AdsOpenIndex

AdsCreateIndex

AdsGetIndexName