DbiOpenTableList

C syntax

DBIResult DBIFN DbiOpenTableList (hDb, bExtended, bSystem, pszWild, phCur);

Delphi syntax

function DbiOpenTableList (hDb: hDBIDb; bExtended: Bool; bSystem: Bool; pszWild: PChar; var hCur: hDBICur): DBIResult stdcall;

Description

DbiOpenTableList creates a table with information about all the tables associated with the database.

Parameters

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

bExtended Type: BOOL (Input)
The bExtended parameter specifies whether to return only the standard table information, or to return extended table information as well. (The default is standard information only).

bSystem Type: BOOL (Input)
The bSystem parameter specifies whether to include system tables or not. SQL only.

pszWild Type: pCHAR (Input)
Pointer to the search string for retrieving a selective list of tables. Two wildcard characters can be used: the asterisk (*) and the question mark (?). The asterisk expands to any number of characters; the question mark expands to a single character.

phCur Type: phDBICur (Output)
Pointer to the cursor handle.

Usage

The client application can request either standard or extended information for the table. The bExtended parameter must be set to TRUE to request extended information.

Standard: The table includes tables in the directory associated with hDb.

SQL: For SQL servers, bSystem must be set to TRUE to include system tables.

Synonyms: Many server vendors (including Oracle) provide objects called synonyms. Synonyms are alternate names for other objects, such as tables or views. SQL Links provides the option to include synonyms in the table lists returned from DbiOpenTableList and DbiOpenFileList. See SQL Links Guide).

Completion state

phCur points to the returned cursor handle. The table contains information about all the tables in the database associated with the specified database handle. If the associated database is a standard database, only the tables in the current directory of the database are listed in the table. The record description for the table is TBLBaseDesc or TBLFullDesc.

DbiResult	Meaning
DBIERR_NONE	The cursor to the table was returned successfully.
DBIERR_INVALIDHNDL	The specified database handle is invalid or NULL.