AdsSetFilter

Advantage Client Engine

Sets a filter on the given table

Syntax

UNSIGNED32

AdsSetFilter (ADSHANDLE hTable,

UNSIGNED8 *pucFilter);

Parameters

hTable (I)

Handle of table or cursor.

pucFilter (I)

Filter expression given as a null terminated string. If there is an existing filter on the given table, it is replaced with the new filter. This affects subsequent record movements other than AdsGotoRecord.

Remarks

Setting a filter through AdsSetFilter allows only the records that pass the filter expression to be visible. The filter expression must result in a boolean True or False. After setting a filter, the table may still be positioned on a record that does not pass the filter. To activate the filter, perform an AdsGotoTop or some other movement function.

See Advantage Expression Engine for a list of functions supported by the Advantage Expression Engine.

Note AdsSetFilter does not utilize the Advantage Optimized Filters functionality. It is recommended you use the AdsSetAOF function.

Example

Click Here

See Also

AdsGetFilter

AdsClearFilter

AdsSetAOF