Advantage Client Engine
Retrieves the conditional index expression of this index order if one exists.
UNSIGNED32 |
AdsGetIndexCondition (ADSHANDLE hIndex, UNSIGNED8 *pucExpr, UNSIGNED16 *pusLen); |
hIndex (I) |
Handle of index order of interest. |
pucExpr (O) |
Return the expression in this buffer. |
pusLen (I/O) |
Length of given buffer on input, length of returned data on output. |
A conditional expression is a logical expression that filters the records placed in an index order. Only records that pass the conditional expression are in the index order. If records that do not pass the conditional expression are modified such that they pass the condition, a key is added to the index for that record. If an updated record no longer passes the condition, any associated key is removed from the index.
If no index condition exists, AdsGetIndexCondition will return an empty string.