IHelpErrorEvent

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.


IHelpErrorEvent - Member Functions and Data by Group

Constructors & Destructor

You can construct and destruct objects of this class although they are typically only created by IHelpHandler objects.


[view class]
~IHelpErrorEvent
public:
virtual ~IHelpErrorEvent()

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
IHelpErrorEvent
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.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


Error Type

IHelpErrorEvent objects contain a value that represents the type of the help-related error.


[view class]
error
public:
ErrorType error() const

Returns the type of help-related error. The returned value is an ErrorType enumerator.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


IHelpErrorEvent - Enumerations


[view class]
ErrorType
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:

loadingDLL
Specifies that the application is unable to load the dynamic link library (DLL) containing the help table resource.
noWindow
Specifies that the window to be associated with the help window object is not a frame window and has no frame window in its parent window chain.
invalidAppHandle
Specifies that the application window to be associated with the help window object does not have a valid window handle.
invalidInstanceHandle
Specifies that the help window object to be associated with the application window does not have a valid window handle.
noHelpInstance
Specifies that neither the frame windows in the parent chain of the specified application window nor its owner window has an associated help window object.
invalidQueryHandle
Specifies that the application window used to query the help window object does not have a valid window handle.
noHelpTable
Specifies that the application did not provide a help table for contextual help.
invalidId
Specifies that the ID of the main help item specified for a contextual help request was not found in the help table.
noIndex
Specifies that the help library file does not contain an index.
noContent
Specifies that the help library file does not have any content.
openHelpFile
Specifies that the help library file cannot be opened.
readHelpFile
Specifies that the help library file cannot be read.
closeHelpFile
Specifies that the help library file cannot be closed.
invalidHelpFile
Specifies that an improper help library file was provided.
notEnoughMemory
Specifies that Information Presentation Facility (IPF) is unable to allocate the memory it needs.
unableFreeMemory
Specifies that IPF is unable to free memory it allocated.
invalidHelpWindow
Specifies that IPF is unable to find the requested help window in the specified help library files.
unopenDatabase
Specifies that IPF is unable to read the unopened help library file.
fontNotFound
Specifies that IPF cannot load a font it requires.
unknown
Specifies that an error not described by any of the other enum values occurred.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


IHelpErrorEvent - Inherited Member Functions and Data

Inherited Public Functions

IEvent

Inherited Public Data

Inherited Protected Functions

Inherited Protected Data