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.
HM_DISPLAY_HELP (1.2)
◄Message Group► ◄Function Group► ◄Overview► ◄Up► ◄Next► ◄Previous►
────────────────────────────────────────────────────────────────────────────
#define INCL_WINHELP
HM_DISPLAY_HELP
mp1 = MPFROMP((PVOID) pHelpPanel); /* panel ID or pointer to name */
mp2 = MPFROMSHORT((USHORT) usTypeFlag); /* ID or name flag */
An application sends an HM_DISPLAY_HELP message to a help window to display
a specific help panel.
Parameter Description
────────────────────────────────────────────────────────────────────────────
pHelpPanel Low and high word of mp1. Points to a help-panel ID, points to a
null-terminated help-panel name, or contains the help-panel ID
in the low word and 0x0000 in the high word.
usTypeFlag Low word of mp2. Specifies whether the pHelpPanel parameter
specifies a help-panel ID or name. The usTypeFlag parameter can
be one of the following values:
Value Meaning
────────────────────────────────────────────────────────────────
HM_RESOURCEID Specifies that pHelpPanel points to the
help-panel ID or contains the help-panel ID in
the low word.
HM_PANELNAME Specifies that pHelpPanel points to the
null-terminated help-panel name.
Return Value
The return value is FALSE if the help panel is displayed. Otherwise, it is
an error value, which may be one of the following:
HMERR_DATABASE_NOT_OPEN
HMERR_PANEL_NOT_FOUND
HMERR_READ_LIB_FILE
Comments
The system searches for the specified panel in the help libraries opened for
the help window and displays the first matching panel found.
See Also
HM_EXT_HELP, HM_HELP_CONTENTS, HM_HELP_INDEX, HM_KEYS_HELP
♦