|
AX_GetAceIndexHandle() Advantage Visual Objects RDD |
|
|
|
AX_GetAceIndexHandle() Advantage Visual Objects RDD |
|
|
Returns the Advantage Client Engine index handle that corresponds with the specified index in the current work area. The handle can be used to call any Advantage Client Engine API directly.
Syntax
AX_GetAceIndexHandle( [<cIndexFile>], [<cOrder> | <nPosition>) -> DWORD
<cIndexFile> |
The name of an index file, including an optional drive and directory (no extension should be specified). Use this argument with <cOrder> to remove ambiguity when there are two or more orders with the same name in different index files. |
<cOrder> | <nPosition> |
The name of the order about which you want the handle or a number representing its position in the order list. (For single-order index files, the order name is the eight-letter index file name.) Using the order name is the preferred method since the position may be difficult to determine using multiple-order index files. Invalid values are ignored. |
If no index file or order is specified, the controlling order is assumed.
Returns
An Advantage Client Engine index order handle or 0 if no index was found.
Description
This function returns the Advantage Client Engine Index handle of the specified index. This function returns 0 if the index was not active or found. The handle can be used to call any Advantage Client Engine API directly. The APIs can be imported into Visual Objects from the ACE.AEF file.
The AX_GetAceIndexHandle function gets the index handle from the current work area. If you are unsure which work area is current, use select() to set it. For example:
select( dbServer:workarea )
or
select( dbServer:alias )
To avoid all ambiguity you could also retrieve the index handle directly from the DBServer object using the Info method. For example:
dbServer:Info( DBOI_GET_ACE_INDEX_HANDLE )
DBOI_GET_ACE_INDEX_HANDLE is defined in the dbfaxs.aef library.