The IHelpErrorEvent class represents error situations that occur while processing help. A help handler creates an IHelpErrorEvent object when an help related error occurs and passes it to you in the callback function IHelpHandler::handleError to allow you to process the error.
You can construct and destruct objects of this class although they are typically only created by IHelpHandler objects.
![]() |
public:
virtual ~IHelpErrorEvent()
Windows | OS/2 | AIX |
Yes | Yes | Yes |
![]() |
public:
IHelpErrorEvent(const IEvent& event)
Constructs an IHelpErrorEvent using the specified event. IHelpHandler::dispatchHandlerEvent constructs objects of this class from an object of the class IEvent and passes the resulting object to the function IHelpHandler::handleError.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
IHelpErrorEvent objects contain a value that represents the type of the help-related error.
![]() |
public:
ErrorType error() const
Returns the type of help-related error. The returned value is an ErrorType enumerator.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
![]() |
enum ErrorType { loadingDLL, noWindow, invalidAppHandle, invalidInstanceHandle, noHelpInstance, invalidQueryHandle, noHelpTable, invalidId, noIndex, noContent, openHelpFile, readHelpFile, closeHelpFile, invalidHelpFile, notEnoughMemory, unableFreeMemory, invalidHelpWindow, unopenDatabase, fontNotFound, unknown }
These enumerators specify the type of error that occurred:
Windows | OS/2 | AIX |
Yes | Yes | Yes |
virtual ~IEvent()
IWindowHandle controlHandle() const
virtual IWindow* controlWindow() const
IEvent& decrementOwnerLevels()
virtual IWindow* dispatchingWindow() const
unsigned long eventId() const
IWindowHandle handle() const
IEvent(const IEvent& event)
IEvent( const IWindowHandle& handle, unsigned long eventId, const IEventParameter1& parameter1, const IEventParameter2& parameter2 )
IEvent( IWindow* window, unsigned long eventId, const IEventParameter1& parameter1, const IEventParameter2& parameter2 )
IEvent& operator =(const IEvent& event)
IEventParameter1 parameter1() const
IEventParameter2 parameter2() const
bool passToOwner() const
IEventResult result() const
IEvent& setControlHandle(const IWindowHandle& handle)
IEvent& setDispatchingHandle(const IWindowHandle& handle)
IEvent& setDispatchingWindow(IWindow* window)
IEvent& setHandle(const IWindowHandle& handle)
IEvent& setNumberOfLevels(int levels = - 1)
IEvent& setPassToOwner(bool passOn = true)
IEvent& setResult(bool eventResult)
IEvent& setResult(const IEventResult& eventResult)
virtual IWindow* window() const