<< Click to Display Table of Contents >> Navigation:  »No topics above this level« DbiGetFilterInfo

C syntax

DBIResult DBIFN DbiGetFilterInfo (hCursor, hFilter, iFilterId, iFilterSeqNo, pFilterinfo);

Delphi syntax

function DbiGetFilterInfo (hCur: hDBICur; hFilter: hDBIFilter; iFilterId: Word; iFilterSeqNo: Word; var Filterinfo: FilterInfo): DBIResult stdcall;

Description

DbiGetFilterInfo retrieves information about a specified filter.

Parameters

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

hFilter                Type: hDBIFilter                (Input)
Specifies the filter handle. Filter handles are not preserved for cloned cursors. Optional, specify a filter handle, filter identification number, or filter sequence number to identify the filter. The default is NULL.

iFilterId                Type: UINT16                (Input)
Specifies the filter identification number. Optional, specify a filter handle, filter identification number, or filter sequence number to identify the filter. The default is 0.

iFilterSeqNo                Type: UINT16                (Input)
Specifies the filter sequence number. Optional, specify a filter handle, filter identification number, or filter sequence number to identify the filter. The default is 0.

pFilterinfo                Type: pFILTERInfo                (Output)
Pointer to the client FILTERInfo structure.