Important Notice

The pages on this site contain documentation for very old MS-DOS software, purely for historical purposes. If you're looking for up-to-date documentation, particularly for programming, you should not rely on the information found here, as it will be woefully out of date.

◄Message Group►  ◄Function Group►  ◄Overview►         ◄Up► ◄Next► ◄Previous►
────────────────────────────────────────────────────────────────────────────
 
#define INCL_WINHELP
 
HM_ERROR
ulErrorCode = (ULONG) LONGFROMMP(mp1);    /* error type */
 
The HM_ERROR message is sent to notify an application of an error in a help
window──errors that occur while the user views help. It does not notify the
application of errors that result from messages sent by the application.
 
Parameter    Description
────────────────────────────────────────────────────────────────────────────
 
ulErrorCode  Low and high word of mp1. Specifies an error value, which may
             be one of the following:
 
                  HMERR_ALLOCATE_SEGMENT
                  HMERR_CLOSE_LIB_FILE
                  HMERR_CONTENT_NOT_FOUND
                  HMERR_DATABASE_NOT_OPEN
                  HMERR_FREE_MEMORY
                  HMERR_HELP_INSTANCE_UNDEFINE
                  HMERR_HELP_INST_CALLED_INVALID
                  HMERR_HELPITEM_NOT_FOUND
                  HMERR_HELPTABLE_UNDEFINE
                  HMERR_INDEX_NOT_FOUND
                  HMERR_INVALID_ASSOC_APP_WND
                  HMERR_INVALID_ASSOC_HELP_INST
                  HMERR_INVALID_DESTROY_HELP_INST
                  HMERR_INVALID_HELPSUBITEM_SIZE
                  HMERR_INVALID_HELP_INSTANCE_HDL
                  HMERR_INVALID_LIB_FILE
                  HMERR_INVALID_QUERY_APP_WND
                  HMERR_NO_FRAME_WND_IN_CHAIN
                  HMERR_NO_HELP_INST_IN_CHAIN
                  HMERR_NO_MEMORY
                  HMERR_OPEN_LIB_FILE
                  HMERR_PANEL_NOT_FOUND
                  HMERR_READ_LIB_FILE
 
Return Value
 
An application should return zero if it processes this message.
 
Comments
 
Because a help window does not display error messages to the user, the
application should display its own messages when it receives an HM_ERROR
message.
 
If an error occurs when creating the help instance using the
WinCreateHelpInstance function, the system copies the error value to the
ulReturnCode field in the HELPINIT structure used with
WinCreateHelpInstance. If an error occurs for another function or for a
message sent to a help window, the return value from the function or message
sent specifies the error.
 
See Also
 
WinCreateHelpInstance, HELPINIT
 
                                      ♦