HM_ERROR

This message notifies the application of an error caused by a user interaction.

Syntax

param1
ULONG ulErrorCode; /* Error code. */

param2
ULONG ulReserved;  /* Reserved value, should be 0. */

Parameters

ulErrorCode (ULONG) - input

Error code.

A constant describing the type of error that occurred. The application

can also receive some of these error constants in the ulReserved parameter of

messages it has sent to the Help Manager.

The error constants are:

HMERR_LOAD_DLL: The resource DLL was unable to be loaded.

HMERR_NO_FRAME_WND_IN_CHAIN: There is no frame window in the window chain from

which to find or set the associated help instance.

HMERR_INVALID_ASSOC_APP_WND: The application window handle specified on the WinAssociateHelpInstance

function is not a valid window handle.

HMERR_INVALID_ASSOC_HELP_INST: The help instance handle specified on the WinAssociateHelpInstance

function is not a valid window handle.

HMERR_INVALID_DESTROY_HELP_INST: The window handle specified as the help

instance to destroy is not of the help instance class.

HMERR_NO_HELP_INST_IN_CHAIN: The parent or owner chain of the application

window specified does not have an associated help instance.

HMERR_INVALID_HELP_INSTANCE_HDL: The handle specified to be a help instance

does not have the class name of a Help Manager instance.

HMERR_INVALID_QUERY_APP_WND: The application window specified on a WinQueryHelpInstance

function is not a valid window handle.

HMERR_HELP_INST_CALLED_INVALID: The handle of the instance specified on a call

to the Help Manager does not have the class name of a Help Manager instance.

HMERR_HELPTABLE_UNDEFINE: The application did not provide a help table for

context-sensitive help.

HMERR_HELP_INSTANCE_UNDEFINE: The help instance handle specified is invalid.

HMERR_HELPITEM_NOT_FOUND: Context-sensitive help was requested, but the ID of

the main help item specified was not found in the help table.

HMERR_INVALID_HELPSUBITEM_SIZE: The help subtable item size is less than 2.

HMERR_HELPSUBITEM_NOT_FOUND: Context-sensitive help was requested, but the ID

of the help item specified was not found in the help subtable.

HMERR_INDEX_NOT_FOUND: The index is not in the library file.

HMERR_CONTENT_NOT_FOUND: The library file does not have any content.

HMERR_OPEN_LIB_FILE: The library file cannot be opened.

HMERR_READ_LIB_FILE: The library file cannot be read.

HMERR_CLOSE_LIB_FILE: The library file cannot be closed.

HMERR_INVALID_LIB_FILE: Improper library file provided.

HMERR_NO_MEMORY: Unable to allocate the requested amount of memory.

HMERR_ALLOCATE_SEGMENT: Unable to allocate a segment of memory for memory

allocation requests from the Help Manager.

HMERR_FREE_MEMORY: Unable to free allocated memory.

HMERR_PANEL_NOT_FOUND: Unable to find the requested help window.

HMERR_DATABASE_NOT_OPEN: Unable to read the unopened database.

ulReserved (ULONG) - input: Reserved value, should be 0.

Returns

ulReserved (ULONG) - return: Reserved value, should be 0.

Remarks

There is no other way to communicate the error to the application since the user initiated communication, not the application. Other errors which occur when the application sends a message to the Help Manager are returned as the ulReserved parameter of the message.

The Help Manager does not display any error messages to the user. Instead, the Help Manager sends or returns all error notifications to the application so that it can display its own messages. This procedure ensures a consistent message interface for all user messages.

Default Processing

None.