DbiDeactivateFilter

C syntax

DBIResult DBIFN DbiDeactivateFilter (hCursor, [hFilter]);

Delphi syntax

function DbiDeactivateFilter (hCursor: hDBICur; hFilter: hDBIFilter): DBIResult stdcall;

Description

DbiDeactivateFilter temporarily disables the specified filter from affecting the record set by turning the filter off.

Parameters

hCursor Type: hDBICur (Input)
Specifies the valid cursor handle from an open table.

hFilter Type: hDBIFilter (Input)
Specifies the filter handle of the filter to deactivate. If NULL, then all filters for this cursor are deactivated.

Usage

Once a filter has been activated, that filter controls what is contained in the record set, and all operations on the associated cursor are affected. Once a filter is deactivated, all the records that were excluded by the filter are now accessible, subject to other active filters.

Prerequisites

The filter must have been previously added and activated. If a non-NULL filter is applied, it must be activated.

DbiResult	Meaning
DBIERR_NONE	The filter specified by hFilter was successfully deactivated. If NULL was passed for the filter handle, all filters were deactivated.
DBIERR_INVALIDHNDL	The specified cursor handle is invalid or NULL.
DBIERR_NOSUCHFILTER	The specified filter handle is invalid.
DBIERR_NA	The filter was already deactivated.