HelpHook - Parameters

hab (HAB) - input

Anchor-block handle.

usMode (ULONG) - input

Help mode.

This has one of the following values, indicating the mode from which help has been requested:

HLPM_FRAME

Standard (standard window)
HLPM_WINDOW
Standard (standard window)
HLPM_MENU
Menu mode

idTopic (ULONG) - input

Topic identifier.

• In menu mode this is a pull-down window identity 
  In message-box mode this is the message-box identity
  
  In standard mode this is a window identity.

  idSubTopic (ULONG) - input

  Subtopic identifier.

  • In menu mode this is a command identity 
    In message-box mode this is a control identity
    
    In standard mode this is the identity of the window with the focus (-1 if none).

    prcPosition (PRECTL) - input

    Rectangle.

    This indicates the screen area (in screen coordinates) from where the help was requested. It is provided to enable the help library to avoid covering that area.

    • In menu mode it is the bounding rectangle of the selected item, or o the top level menu if value of the idSubTopic parameter is -1. 
      In message-box mode it is the bounding rectangle of the button.
      
      In standard mode it is the bounding rectangle of the window with the focus, or of the window sent the message if the value of the idSubTopic parameter is -1.
      Note: The data type WRECT can also be used, if supported by the language.

    rc (BOOL) - returns

    Indicator as to whether next hook in the chain is called.

    The message is always passed to the application.

    TRUE

    The next hook in the chain is not called.
    FALSE
    The next hook in the chain is called.

    ---

    [Back: HelpHook Return Value - rc]
    [Next: HelpHook - Remarks]