AdsIsIndexCustom

Advantage Client Engine

Determines if the given index order was built as a custom index.

Syntax

UNSIGNED32

AdsIsIndexCustom (ADSHANDLE hIndex,

UNSIGNED16 *pbCustom);

Parameters

hIndex (I)

Handle of index order of interest.

pbCustom (O)

Return True if it is a custom index order.

Special Return Codes

AE_INVALID_INDEX_TYPE

NTX indexes cannot be custom.

Remarks

A custom index is built without keys. Keys are added to the custom index explicitly by calls to AdsAddCustomKey and AdsDeleteCustomKey. This allows a user to build a very small and specific index.

Custom indexes can only be built on tables opened with the ADS_CDX or ADS_ADT option.

Example

Click Here

See Also

AdsCreateIndex

AdsOpenIndex

AdsAddCustomKey

AdsDeleteCustomKey