The HELPWININFO Structure


  

typedef struct {     // hwi

int wStructSize;

int x;

int y;

int dx;

int dy;

int wMax;

TCHAR rgchMember[2];

} HELPWININFO;   

 

The HELPWININFO structure contains the size and position of either a primary or a secondary Help window.

 

ParameterDescription

wStructSizeSize of this structure, in bytes.

xX-coordinate of the upper left corner of the window, in screen coordinates.

yY-coordinate of the upper left corner of the window, in screen coordinates.

dxWidth of the window, in pixels.

dyHeight of the window, in pixels.

wMaxValue specifying how to show the window. This member must be one of these values:

ValueMeaning

SW_HIDEHides the window and passes activation to another window.

SW_MINIMIZEMinimizes the specified window and activates the top-level window in the Z order.

SW_RESTORESame as SW_SHOWNORMAL.

SW_SHOWActivates a window and displays it in its current size and position.

SW_SHOWMAXIMIZEDActivates the window and displays it as a maximized window.

SW_SHOWMINIMIZEDActivates the window and displays it as an icon.

SW_SHOWMINNOACTIVEDisplays the window as an icon. The window that is currently active remains active.

SW_SHOWNADisplays the window in its current state. The window that is currently active remains active.

SW_SHOWNOACTIVATEDisplays a window in its most recent size and position. The window that is currently active remains active.

SW_SHOWNORMALActivates and displays the window. Whether the window is minimized or maximized, Windows restores it to its original size and position.

rgchMemberName of the window.

 

Comments

WinHelp divides the display into 1024 units in both the x- and y-directions. To create a secondary window that fills the upper left quadrant of the display, for example, a program would specify zero for the x and y members and 512 for the dx and dy members.

 

A program can set the size and position information by calling the WinHelp function with the HELP_SETWINPOS value.

 

Training Card Help

Using training card help, an application can display a sequence of instructions to guide the user through the steps of a task. A training card typically consists of text that explains a particular step and authorable buttons associated with TCard macros that allow the user to tell the application what to do next. Training cards may only be displayed in secondary windows and must not contain hot links to other topics in the help file.

 

An application initiates the training card instance of Windows Help by calling the WinHelp function and specifying the HELP_TCARD command in combination with another command such as HELP_CONTEXT. Subsequently, when the user clicks an authorable button in the training card, clicks a hot spot assigned to the TCard macro, or closes the training card, Windows Help notifies the application by sending it a WM_TCARD message. The wParam parameter identifies the button or user action, and the lParam parameter contains additional data, the meaning of which depends on the value of wParam.

 

See Also

Calling WinHelp()

Calling WinHelp Version 4.0

#defines list

Examples

FuCommand Parameters

HELP Context ID Property  

The HELPINFO Structure

The MULTIKEYHELP Structure

The WM TCARD Message

Visual Basic