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

C syntax

DBIResult DBIFN DbiGetErrorInfo (bFull, pErrInfo);

Delphi syntax

function DbiGetErrorInfo (bFull: Bool; var ErrInfo: DBIErrInfo): DBIResult stdcall {$ENDIF};

Description

DbiGetErrorInfo provides descriptive error information about the last error that occurred, and error contexts for the first four error messages on the error stack.

Parameters

bFull                Type: BOOL                (Input)
Not currently used.

pErrInfo                Type: pDBIErrInfo                (Output)
Pointer to the client DBIErrInfo structure.

Usage

Error information consists of the DBIResult error code, an error message in ANSI characters corresponding to the code, and up to four associated error contexts. For example, if the error message is "Table Not Found," the user might want to know the table name. The BDE engine logged the table name with the error context ecTABLENAME, which can be found in one of the contexts contained in the DBIErrInfo structure.

Prerequisites

This function is designed for immediate display to the user, so unlike the function DbiGetErrorContext, the client does not need to be concerned about the different types of error contexts. If the client wishes to interpret certain error codes and contexts (for example, the ALIAS error context), DbiGetErrorContext should be used.

See also

DbiGetErrorContext