FairCom DB API for C

ctdbIsFilteredRecord

Indicate if the record is being filtered or not.

Declaration

CTBOOL ctdbIsFilteredRecord(CTHANDLE Handle)

Description

ctdbIsFilteredRecord() indicates if the records are being filtered or not. To insert filtering logic to the record retrieval, use ctdbFilterRecord().

• Handle [in] the Record or Table Handle.

Returns

ctdbIsFilteredRecord() returns YES if the record has been filtered, and NO otherwise.

Example

/* if record filter is active, turn it off */

if (ctdbIsFilteredRecord(hRecord))

ctdbSetFilter(hRecord, NULL, CTFILTER_NONE);

See also

ctdbFilterRecord(), ctdbGetFilter(), ctdbGetFilterType(), ctdbIsFilteredRecord(), ctdbSetFilter()