Share via


COleControl::DisplayError

Called by the framework after the stock Error event has been handled (unless the event handler has suppressed the display of the error).

virtual void DisplayError( 
   SCODE scode, 
   LPCTSTR lpszDescription, 
   LPCTSTR lpszSource, 
   LPCTSTR lpszHelpFile, 
   UINT nHelpID  
);

Parameters

  • scode
    The status code value to be reported. For a complete list of possible codes, see the article ActiveX Controls: Advanced Topics.

  • lpszDescription
    The description of the error being reported.

  • lpszSource
    The name of the module generating the error (typically, the name of the OLE control module).

  • lpszHelpFile
    The name of the help file containing a description of the error.

  • nHelpID
    The Help Context ID of the error being reported.

Remarks

The default behavior displays a message box containing the description of the error, contained in lpszDescription.

Override this function to customize how errors are displayed.

Requirements

Header: afxctl.h

See Also

Reference

COleControl Class

Hierarchy Chart

COleControl::FireError