HELPINFO Structure

Type HELPINFO
  cbSize As Long
  iContextType As Long
  iCtrlId As Long
  hItemHandle As Long
  dwContextId As Long
  MousePos As POINT_TYPE
End Type

Description & Usage

The HELPINFO structure holds information about a help request. The structure holds details about the object or other item about which help information is requested by the user. The structure does not specify the help documentation itself, but rather the object for which context-sensitive help is wanted.

Visual Basic-Specific Issues

None.

Data Members

cbSize

The size in bytes of the structure.

iContextType

One of the following flags specifying the type of context for which help information is requested:

HELPINFO_MENUITEM

Help information is requested for a menu item.

HELPINFO_WINDOW

Help information is requested for a control or window.

iCtrlId

An identifier of the window, control, or menu item for which context-sensitive help is desired.

hItemHandle

A handle to the window or control (if iContextType is HELPINFO_WINDOW) or an identifier of the associated menu (if iContextType is HELPINFO_MENUITEM) for which context-sensitive help is desired.

dwContextId

The help context identifier of the window or control.

MousePos

The coordinates of the mouse cursor when help information was requested.

Constant Definitions

Const HELPINFO_MENUITEM = 2
Const HELPINFO_WINDOW = 1

Used By

MsgBoxCallback, WM_HELP

Back to the Structure list.
Back to the Reference section.

Last Modified: January 29, 2000
This page is copyright © 2000 Paul Kuliniewicz. Copyright Information Revised October 29, 2000
Go back to the Windows API Guide home page.
E-mail: vbapi@vbapi.com Send Encrypted E-Mail
This page is at http://www.vbapi.com/ref/h/helpinfo.html