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_EXT_HELP
mp1 = 0L;    /* not used, must be zero */
mp2 = 0L;    /* not used, must be zero */
 
An application sends an HM_EXT_HELP message to a help window to display the
extended help panel.
 
This message does not use any parameters.
 
Return Value
 
The return value is FALSE if the extended 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
 
For this message to display an extended help panel, the help table for the
help instance must specify a help-panel ID that corresponds to the active
window. (For example, the idExtPanel in the HELPTABLE structure used with
the WinCreateHelpInstance function must be set to a valid help-panel ID.) If
the help table specifies zero for the extended help-panel ID, the system
sends the HM_EXT_HELP_UNDEFINED message to the application. In this case,
the application should carry out some default action, such as displaying an
error message or using the HM_DISPLAY_HELP message to display a help panel.
 
See Also
 
HM_DISPLAY_HELP, HM_EXT_HELP_UNDEFINED, HM_HELP_INDEX, HM_KEYS_HELP,
HELPTABLE
 
                                      ♦