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

C syntax

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

Delphi syntax

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

Description

DbiOpenVchkList creates a table containing records with information about validity checks for fields within the specified table.

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.

For SQL databases, this parameter can be a fully qualified name that includes the owner name.

pszDriverType                Type: pCHAR                (Input)
Pointer to the driver type. For Paradox, required only if no extension is specified by pszTableName. The only valid type is szPARADOX. This parameter is ignored if the database associated with hDb is a SQL database.

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

Usage

Paradox: This function returns information about validity checks including required fields, minimum/maximum settings for fields, lookup tables, picture specifications, and default values.

SQL: The only validity check that can be created for SQL tables is bRequired (required fields). However, some drivers support reporting of fields with default values.

dBASE, FoxPro, Access: This function is not supported.

Prerequisites

A valid database handle must be obtained.

Completion state

phChkCur points to the returned cursor handle on the table. Once the cursor is returned, the client application can retrieve information about validity checks from the table. The cursor is read-only.

See also

DbiOpenRintList, DbiCreateTable, DbiGetVchkDesc