Share via

CSimpleException::GetErrorMessage

  • Article

Call this member function to provide text about an error that has occurred.

virtual BOOL GetErrorMessage( 
   LPTSTR lpszError, 
   UINT nMaxError, 
   PUNIT pnHelpContext = NULL 
);

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.

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

Return Value

Nonzero if the function is successful; otherwise 0 if no error message text is available.

Remarks

For more information, see CException::GetErrorMessage.

Requirements

Header: afx.h

See Also

Reference

CSimpleException Class