DbiDropFilter

C syntax

DBIResult DBIFN DbiDropFilter (hCursor, [hFilter]);

Delphi syntax

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

Description

DbiDropFilter drops the specified filter and frees all resources associated with the filter.

Parameters

hCursor Type: hDBICur (Input)
Specifies the cursor handle.

hFilter Type: hDBIFilter (Input)
Specifies the filter handle.

Usage

The filter is automatically deactivated before being dropped, and automatically dropped when the cursor is closed. Providing a NULL filter handle drops all filters for this cursor. If no filters are activated and NULL has been specified for the filter handle, no error condition is returned.

Prerequisites

The filter must have been previously added.

DbiResult	Meaning
DBIERR_NONE	The filter specified by the filter handle was successfully dropped. If NULL is passed for the filter handle, all filters, if any, were dropped.
DBIERR_INVALIDHNDL	The specified cursor handle is invalid or NULL.
DBIERR_NOSUCHFILTER	The filter handle (hFilter) is invalid.