DbiOpenRintList

C syntax

DBIResult DBIFN DbiOpenRintList (hDb, pszTableName, [pszDriverType], phChkCur);

Delphi syntax

function DbiOpenRintList (hDb: hDBIDb; pszTableName: PChar; pszDriverType: PChar; var hChkCur: hDBICur): DBIResult stdcall;

Description

DbiOpenRintList creates a table listing the referential integrity links for a specified table, along with their descriptions.

Parameters

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

pszTableName Type: pCHAR (Input)
Pointer to the table name. If pszTableName is a fully qualified name of a table, the pszDriverType parameter need not be specified. If the path is not included, the path name is taken from the current directory of the database associated with hDb.

pszDriverType Type: pCHAR (Input)
Pointer to the driver type; required only if no extension is specified by pszTableName. Currently, the only valid type is szPARADOX.

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

Usage

Retrieve each of the referential integrity records by using DbiGetNextRecord. Use DbiGetCursorProps to allocate the proper record size. After the record is retrieved, it can be cast with the RINTDesc type definition, and used like a RINTDesc C language structure.

Currently, this function is supported only with Paradox, dBASE, and Access tables.

DbiResult	Meaning
DBIERR_NONE	The cursor to the table was successfully returned.
DBIERR_INVALIDPARAM	The specified table name or pointer to the table name is NULL.
DBIERR_INVALIDHNDL	The specified database handle is invalid or NULL, or phChkCur is NULL.
DBIERR_UNKNOWNTBLTYPE	The specified table type is invalid.
DBIERR_NOSUCHTABLE	The specified table does not exist.