AdsIsIndexCandidate

Advantage Client Engine

Determines if the given index order is a candidate index.

Syntax

UNSIGNED32

AdsIsIndexCandidate ( ADSHANDLE hIndex,

UNSIGNED16 *pbCandidate );

Parameters

hIndex (I)

Handle of index order of interest.

pbCandidate (O)

Return True if it is a candidate index.

Remarks

AdsIsIndexCandidate returns whether or not an index order was created with the ADS_CANDIDATE option.

Note AdsIsIndexCandidate can only be called on indexes of ADS_ADT or ADS_VFP tables.

Example

ulRetCode = AdsIsIndexCandidate( hIndex, &usCandidate );

See Also

AdsOpenIndex

AdsCreateIndex

AdsIsIndexUnique