DbiGetVchkDesc

<< Click to Display Table of Contents >>

Navigation:  »No topics above this level«

DbiGetVchkDesc

Return to chapter overview

C syntax

DBIResult DBIFN DbiGetVchkDesc (hCursor, iValSeqNo, pvalDesc);

Delphi syntax

function DbiGetVchkDesc (hCursor: hDBICur; iValSeqNo: Word; pvalDesc: pVCHKDesc): DBIResult stdcall;

Description

DbiGetVchkDesc retrieves the validity check descriptor identified by the validity check sequence number and the cursor.

Parameters

hCursor                Type: hDBICur                (Input)
Specifies the cursor handle.

iValSeqNo                Type: UINT16                (Input)
The validity check sequence number. This number is between 1 and the value of iValChecks. The value of iValChecks can be obtained from the cursor properties (CURProps) structure.

pvalDesc                Type: pVCHKDesc                (Output)
Pointer to the client-allocated VCHKDesc structure.

Usage

If a field map is active, the iFldNum in the validity check descriptor reflects the field map. If any of the fields are not part of the field-mapped record, a negative number is listed.

DbiResult

Meaning

DBIERR_NONE

The descriptor was returned successfully.

See also

DbiGetCursorProps, DbiOpenVChkList