Skip Headers
Oracle® Objects for OLE C++ Class Library Developer's Guide
10g Release 2 (10.2)

Part Number B14308-01
Go to Documentation Home
Home
Go to Book List
Book List
Go to Table of Contents
Contents
Go to Index
Index
Go to Master Index
Master Index
Go to Feedback page
Contact Us

GetErrorText Method

Applies To

OAdvise, OBinder, OClient, OConnection, OConnectionCollection, ODatabase, ODatabaseCollection, ODynaset, ODynasetMark, OField, OFieldCollection, OParameter, OParameterCollection, OSession, OSessionCollection

Description

This method returns a text description (if one is available) of the current internal class library error.

Usage

const char *GetErrorText(void) const

Remarks

This method returns a text description of the most recent internal error on this object. If no error condition exists, or if no text is available for the most recent error, the method returns a NULL. Calling ErrorNumber gives you the error number even if no text is available.

The string returned is owned by the object. The caller should not free it; it will be freed when the object is destroyed, closed, or the next time the error is reset. The error is reset whenever you call a method.

Oracle database errors (as distinct from error that occur in the use of the class library) are reported through the OSession and ODatabase methods ServerErrorNumber and GetServerErrorText.

Return Value

A test description (if one is available) of the current internal class library error.