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

C syntax

DBIResult DBIFN DbiOpenFunctionList (hDb, eUserDefined, phCur);

Delphi syntax

function DbiOpenFunctionList (hDb: hDBIDb; eoptBits: DBIFUNCOpts; var hCur: hDBICur): DBIResult stdcall;

Description

DbiOpenFunctionList opens a cursor to a schema table containing a list of all the functions for the driver associated with hDb. Record description is of type DBIFUNCDesc. For SQL data source only.

Parameters

hDb                Type: hDBIDb                (Input)
Specifies the universal database handle.

eUserDefined                Type: DBIFUNCOpts                (Input)
Set to fnListINCL_USER_DEF (the only setting included in the enumeration) to include user-defined functions. For InterBase only.

phCur                Type: phDBICur                (Output)
Specifies returned cursor on functions

Usage

Use DbiOpenFunctionList to retrieve the list of functions supported by the data source. This information can be useful for clients developing a visual query builder.

Prerequisites

DbiInit must be called, and hDb must reference a SQL data source.

Completion state

Returns a cursor to a schema table that lists all functions supported by the database. When building a SQL query this cursor must be closed with a call to DbiCloseCursor.

See also

DbiOpenFunctionArgList