Jump to content

HM_KEYS_HELP

From EDM2
Revision as of 04:02, 28 April 2025 by Martini (talk | contribs) (Created page with "{{DISPLAYTITLE:HM_KEYS_HELP}} This message is sent by the application and informs the help manager to display the keys help window. ==Syntax== <pre> param1 ULONG ulReserved; Reserved value, should be 0.: param2 ULONG ulReserved; Reserved value, should be 0.: </pre> ==Parameters== ;ulReserved (ULONG) - input: Reserved value, should be 0. ;ulReserved (ULONG) - input: Reserved value, should be 0. ==Returns== ;rc (ULONG) - return: Return code. ::0:...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

This message is sent by the application and informs the help manager to display the keys help window.

Syntax

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

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

Parameters

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

Returns

rc (ULONG) - return
Return code.
0: The keys help window was successfully displayed.
Other: See the values of the ulErrorCode parameter of the HM_ERROR message.

Remarks

When the Help Manager receives this message, it sends a HM_QUERY_KEYS_HELP message to the active application window. The active application window is the window that was specified when the last HM_SET_ACTIVE_WINDOW message was sent. If no HM_SET_ACTIVE_WINDOW message was issued, then the active application window is the window specified in the WinAssociateHelpInstance call.

The application must return one of the following:

  • The identity of a keys help window in the usHelpPanel parameter of the HM_QUERY_KEYS_HELP message.
  • Zero, if no action is to be taken by the Help Manager for keys help.

Default Processing

None.