Jump to content

HM_HELPSUBITEM_NOT_FOUND

From EDM2
Revision as of 03:59, 28 April 2025 by Martini (talk | contribs) (Remarks)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

The Help Manager sends this message to the application when the user requests help on a field and it cannot find a related entry in the help subtable.

Syntax

param1
USHORT usContext; /* Type of window on which help was requested. */

param2
SHORT sTopic;    /* Topic identifier. */
SHORT sSubTopic; /* Subtopic identifier. */

Parameters

usContext (USHORT) - input
Type of window on which help was requested.
HLPM_WINDOW: An application window.
HLPM_FRAME: A frame window.
HLPM_MENU: A menu window.
sTopic (SHORT) - input
Topic identifier.
For a value of the usContext parameter of HLPM_WINDOW or HLPM_FRAME:
window: Identity of the window containing the field on which help was
requested.
menu: Identity of the submenu containing the field on which help was requested.
sSubTopic (SHORT) - input
Subtopic identifier.
For a value of the usContext parameter of HLPM_WINDOW or HLPM_FRAME:
control: Control identity of the cursored field and on which help was
requested.
For a value of the usContext parameter of HLPM_MENU:
-1: No menu item was selected.
other: Menu item identity of the currently selected submenu item on which help
was requested.

Returns

rc (BOOL) - return
Action indicator.

Remarks

If FALSE is returned from this message, the Help Manager displays the extended help window.

The application has the following options:

  • Ignore the notification and not display help for that field or window.
  • Display its own window.
  • Use the HM_DISPLAY_HELP message to tell the Help Manager to display a particular window.

Default Processing

None.