DbiGetErrorEntry

<< Click to Display Table of Contents >>

Navigation:  »No topics above this level«

DbiGetErrorEntry

Return to chapter overview

C syntax

DBIResult DBIFN DbiGetErrorEntry (uEntry, pulNativeError, pszError);

Delphi syntax

function DbiGetErrorEntry (uEntry: Word; var ulNativeError: Longint; pszError: PChar): DBIResult stdcall;

Description

DbiGetErrorEntry returns the error description (including native server errors returned from SQL systems) of a specified error stack entry.

Parameters

uEntry                Type: UINT16                (Input)
Specifies the error stack entry.

pulNativeError                Type: pUINT32                (Output)
Pointer to the client variable that receives the native error code (if any).

pszError                Type: pCHAR                (Output)
Pointer to the client-allocated buffer that receives the error string (if any).

Usage

Error stack entries begin with 1. Each stack entry contains a DBIERR, and possibly a native error code and a native error message. DBIERR_NONE is returned for stack entries beyond the current error stack, so this successful return can be used as a loop termination. For example, if error entry 1 returns DBIERR_NONE, there are no errors on the stack. Both the native error code and the native error message result are optional. The stack can be traversed multiple times, or combined with other error interface calls, but non-error routine BDE calls reset the error stack.

DbiResult

Meaning

DBIERR_NONE

The error stack entry is empty.

Any other error return value indicates what the error code is that is contained in the error stack entry.

See also

DbiGetErrorInfo, DbiGetErrorString