Documentation Format

Each entry in this reference will appear in the following format. The following entry shows an annotated example:

The function declaration is given in shorthand. This shows the calling sequence of the parameters.

DbiActivateFilter ( hCursor, hFilter )

Each of the parameters is documented in a table that follows the function declaration.

Parameter

Data TvOe

Description hCursor hFilter hDBICur hDBIFilter

The cursor handle.

The handle to the filter to be applied.

Part Ili-The Well-Rounded Application

The functions all return a code indicating whether they were successful or not. If there was an error in the transaction, a code will be returned here.

RETURNS : DBIResult

A text description of the function is provided at the end of each definition.

DbiActivateFilter activates a preset filter associated with the cursor. Numerous filters can be associated with the same cursor. To activate all filters for a cursor, set the hFilter parameter to NIL.

Was this article helpful?

0 0

Post a comment