File Geodatabase API
FileGDBAPI::ErrorInfo Namespace Reference

Provides access to error text and extended error information. More...

Functions

EXT_FILEGDB_API fgdbError GetErrorDescription (fgdbError fgdbError, std::wstring &errorDescription)
 Returns the text error message which corresponds to an error code. More...
 
EXT_FILEGDB_API void GetErrorRecordCount (int &recordCount)
 Returns the number of error records in the error stack. More...
 
EXT_FILEGDB_API fgdbError GetErrorRecord (int recordNum, fgdbError &fgdbError, std::wstring &errorDescription)
 Returns an error record. More...
 
EXT_FILEGDB_API void ClearErrors (void)
 Clears the error stack. More...
 

Detailed Description

Provides access to error text and extended error information.

Function Documentation

EXT_FILEGDB_API fgdbError FileGDBAPI::ErrorInfo::GetErrorDescription ( fgdbError  fgdbError,
std::wstring &  errorDescription 
)

Returns the text error message which corresponds to an error code.

If there is no description corresponding to the error code, the error description string will be empty and a 1 (S_FALSE) error will be returned.

Parameters
[in]fgdbErrorThe error code to look up.
[out]errorDescriptionThe description of the error.
Returns
Error code indicating whether the method finished successfully.
EXT_FILEGDB_API void FileGDBAPI::ErrorInfo::GetErrorRecordCount ( int &  recordCount)

Returns the number of error records in the error stack.

Parameters
[out]recordCountThe number of error records.
Returns
Void.
EXT_FILEGDB_API fgdbError FileGDBAPI::ErrorInfo::GetErrorRecord ( int  recordNum,
fgdbError &  fgdbError,
std::wstring &  errorDescription 
)

Returns an error record.

Parameters
[in]recordNumThe error record to return.
[out]fgdbErrorThe error code.
[out]errorDescriptionThe description of the error.
Returns
Error code indicating whether the method finished successfully.
EXT_FILEGDB_API void FileGDBAPI::ErrorInfo::ClearErrors ( void  )

Clears the error stack.

Returns
Void.