DbiOpenDatabaseList

C syntax

DBIResult DBIFN DbiOpenDatabaseList (phCur);

Delphi syntax

function DbiOpenDatabaseList (var hCur: hDBICur): DBIResult stdcall;

Description

DbiOpenDatabaseList returns a cursor on a list of accessible databases (and all aliases) found in the configuration file.

Parameters

phCur Type: phDBIcur (Output)
Pointer to an in-memory table.

Usage

Accessible databases are those that are defined within the configuration file. The cursor should be closed after information retrieval is complete. Each of the database records can be retrieved by using DbiGetNextRecord. DbiGetCursorProps can be used to allocate the proper record size. After the record is retrieved, it can be cast with the DBDesc type definition, and used like an DBDesc C language structure.

Completion state

A cursor on a list of accessible databases is returned. The cursor is positioned before the first record.

Note:

The session property sesCFGMODE2 can affect the list returned by this function.

DbiResult	Meaning
DBIERR_NONE	The table was created successfully.
DBIERR_INVALIDHNDL	phCur is NULL.