AdsCloseIndex

Advantage Client Engine

  This is the first topic This is the last topic  

Closes an index order.

Syntax

UNSIGNED32

AdsCloseIndex (ADSHANDLE hIndex);

Parameters

hIndex (I)

Handle of index order to close. If this is the handle of an index order (tag) within a compound index file, then the file is closed. The file is not deleted.

Remarks

It is not possible to close an AutoOpen index. Any attempts to use an index handle that is closed with an Advantage Client Engine function will result in AE_INVALID_INDEX_HANDLE being returned. The index file can be reopened as long as the table it is associated with is open.

Note Updating data in a table without all associated indexes being opened can result in index corruption. If such corruption occurs, it can be repaired by calling AdsReindex on the table handle.

 

Note It is illegal to close an index order during a transaction.

Example

Click Here

See Also

AdsOpenIndex

AdsCreateIndex

AdsCloseAllIndexes