Product Documentation

c-treeDB API for C++ - Developers Guide

Previous Topic

Next Topic

CTRecord::IsFiltered

Indicates if a filter condition is active for this record object.

Declaration

CTBOOL CTRecord::IsFiltered();

Description

IsFiltered indicates whether a filter condition is active for this record object.

Return

Value

Symbolic Constant

Explanation

0

NO

No filter condition is active.

1

YES

A filter condition is active.

Example

// if the record filter is active, retrieve the filter expression

if (hRecord.IsFiltered())

{

CTString expr;

hRecord.GetFilter(expr);

printf("Filter expression %s\n", expr.c_str());

}

See Also

CTRecord::SetFilter(), CTRecord::GetFilter()

TOCIndex