|
<< Click to Display Table of Contents >> DbiGetDatabaseDesc |
  
|
|
<< Click to Display Table of Contents >> DbiGetDatabaseDesc |
|
C syntax
DBIResult DBIFN DbiGetDatabaseDesc (pszName, pdbDesc);
Delphi syntax
function DbiGetDatabaseDesc (pszName: PChar; pdbDesc: pDBDesc): DBIResult stdcall;
Description
DbiGetDatabaseDesc retrieves the description of the specified database from the configuration file.
Parameters
pszName Type: pCHAR (Input)
Pointer to the database name.
pdbDesc Type: pDBDesc (Output)
Pointer to the client-allocated DBDesc structure.
Prerequisites
A valid database (alias) name must be specified.
Completion state
The output buffer contains the database description.
DbiResult |
Meaning |
DBIERR_NONE |
The database description for pszName was retrieved successfully. |
DBIERR_OBJNOTFOUND |
The database named in pszName was not found. |
See also