CODException::GetErrorMessage

BOOL CODException::GetErrorMessage(LPTSTR lpszError, UINT nMaxError, PUINT pnHelpContext = )

Returns a string error message for the exception.

Defined in: OdException.cpp

Return Value

TRUE if the error message successfully loaded; otherwise FALSE.

Parameters

lpszError

A pointer to a buffer that will receive an error message.

nMaxError

The maximum number of characters the buffer can hold, including the NULL terminator.

Comments

This method calls the virtual function GetMessageId to get a string resource ID for the error message.

pnHelpContext

The address of a UINT that will receive the help context ID. If NULL, no ID will be returned.