FuCommand Parameters

The following table shows the possible values for the fuCommand parameter and the corresponding formats of the dwData parameter:

fuCommand

Action

dwData

HELP_COMMAND

Runs a Help macro or macro string.

Address of a string that specifies the name of the Help macro(s) to run. If the string specifies multiple macro names, the names must be separated by colons or semicolons. You must use the short form of the macro name for some Macros because WinHelp does not support the long name.

HELP_CONTENTS

Displays the topic specified by the
Contents option in the [OPTIONS]
section of the .HPJ file. This command is for backward compatibility. New programs should provide a .CNT file and use the HELP_FINDER command.

Ignored; set to 0.

HELP_CONTEXT

Displays the topic identified by the defined containing the context in the [MAP] section of the .HPJ file.

Unsigned long integer specified context identifier identifier for the topic.

HELP_CONTEXTMENU

Displays the Help menu for the selected window, and then displays (in a pop-up window) topic for the selected control.

Address of an array of double word pairs. The first double word in each pair is a control identifier, and the second is a context number for a topic.

HELP_CONTEXTPOPUP

Displays, in a pop-up window, the topic identified by the specified context identifier defined in the [MAP] section of the .HPJ file.

Unsigned long integer containing the context identifier for a topic.

HELP_FINDER

Displays the Help Topics dialog box.

Ignored; set to 0.

HELP_FORCEFILE

Ensures that WinHelp is displaying the correct Help file. If the incorrect Help file is being displayed, WinHelp opens the correct one; otherwise, there is no action.

Ignored; set to 0.

HELP_HELPONHELP

Displays Help on how to use WinHelp, if the WINHLP32.HLP file is available.

Ignored; set to 0.

HELP_INDEX

Displays the topic specified by Ignored; set to 0. the CONTENTS option in the
[OPTIONS] section of the .HPJ file. This command is for backward compatibility. New programs should provide a .CNT
file and use the HELP_FINDER
command.

Ignored; set to 0.

HELP_KEY

Displays the topic in the keyword table that matches the specified keyword, if there is an exact match. If there is more than one match, this command displays the Topics Found list box.

Address of a keyword string. Multiple keywords must be separated by semi-colons.

HELP_MULTIKEY

Displays the topic specified bykeyword in an alternative keyword table.

Address of a MULTIKEYHELP structure that specifies a table footnote character and a keyword.

HELP_PARTIALKEY

Displays the topic in the keyword table that matches the specified keyword if there is an exact match, this command displays the Topics Found dialog box. To display the Index without passing a keyword, you should use a pointer to an empty string.

Address of a keyword string. Multiple keywords must be separated by semi-colons.

HELP_QUIT

Informs the WinHelp program that it is no longer needed. If no other programs have asked for Help, Windows closes the WinHelp program.

Ignored; set to 0.

HELP_SETCONTENTS

Specifies the Contents topic. The WinHelp program displays this topic when the user clicks identifier for the Contents the Contents button if the Help
file does not have an associated .CNT file.

Unsigned long integer containing the context identifier for the Contents topic.

HELP_SETPOPUP_POS

Sets the position of the subsequent pop-up window.

Address of a POINTS structure. The pop-up window is positioned as if the mouse cursor were at specified point when the pop-up window is invoked.

HELP_SETWINPOS

Displays the Help window, if it is minimized or in memory, and sets its size and position as specified.

Address of a HELPWININFO structure that specifies the size and position of either a primary or secondary Help window.

HELP_TCARD

Indicates that a command is for a training card instance of the WinHelp program. A program combines the HELP_TCARD flag with other commands by using the bitwise OR operator.

Depends on the command with which the flag is combined.

HELP_WM_HELP

Displays, in a pop-up window, the topic for the control identified by hwnd.

Address of an array of double word pairs. The first double word in each pair is a control identifier, and the second is a context identifier for a topic.

See Also

Calling WinHelp()

Calling WinHelp Version 4.0

#defines list

Examples

HELP Context ID Property

The HELPINFO Structure

The HELPWININFO Structure

The MULTIKEYHELP Structure

The WM TCARD Message

Visual Basic

fuCommand	Action	dwData
HELP_COMMAND	Runs a Help macro or macro string.	Address of a string that specifies the name of the Help macro(s) to run. If the string specifies multiple macro names, the names must be separated by colons or semicolons. You must use the short form of the macro name for some Macros because WinHelp does not support the long name.
HELP_CONTENTS	Displays the topic specified by the Contents option in the [OPTIONS] section of the .HPJ file. This command is for backward compatibility. New programs should provide a .CNT file and use the HELP_FINDER command.	Ignored; set to 0.
HELP_CONTEXT	Displays the topic identified by the defined containing the context in the [MAP] section of the .HPJ file.	Unsigned long integer specified context identifier identifier for the topic.
HELP_CONTEXTMENU	Displays the Help menu for the selected window, and then displays (in a pop-up window) topic for the selected control.	Address of an array of double word pairs. The first double word in each pair is a control identifier, and the second is a context number for a topic.
HELP_CONTEXTPOPUP	Displays, in a pop-up window, the topic identified by the specified context identifier defined in the [MAP] section of the .HPJ file.	Unsigned long integer containing the context identifier for a topic.
HELP_FINDER	Displays the Help Topics dialog box.	Ignored; set to 0.
HELP_FORCEFILE	Ensures that WinHelp is displaying the correct Help file. If the incorrect Help file is being displayed, WinHelp opens the correct one; otherwise, there is no action.	Ignored; set to 0.
HELP_HELPONHELP	Displays Help on how to use WinHelp, if the WINHLP32.HLP file is available.	Ignored; set to 0.
HELP_INDEX	Displays the topic specified by Ignored; set to 0. the CONTENTS option in the [OPTIONS] section of the .HPJ file. This command is for backward compatibility. New programs should provide a .CNT file and use the HELP_FINDER command.	Ignored; set to 0.
HELP_KEY	Displays the topic in the keyword table that matches the specified keyword, if there is an exact match. If there is more than one match, this command displays the Topics Found list box.	Address of a keyword string. Multiple keywords must be separated by semi-colons.
HELP_MULTIKEY	Displays the topic specified bykeyword in an alternative keyword table.	Address of a MULTIKEYHELP structure that specifies a table footnote character and a keyword.
HELP_PARTIALKEY	Displays the topic in the keyword table that matches the specified keyword if there is an exact match, this command displays the Topics Found dialog box. To display the Index without passing a keyword, you should use a pointer to an empty string.	Address of a keyword string. Multiple keywords must be separated by semi-colons.
HELP_QUIT	Informs the WinHelp program that it is no longer needed. If no other programs have asked for Help, Windows closes the WinHelp program.	Ignored; set to 0.
HELP_SETCONTENTS	Specifies the Contents topic. The WinHelp program displays this topic when the user clicks identifier for the Contents the Contents button if the Help file does not have an associated .CNT file.	Unsigned long integer containing the context identifier for the Contents topic.
HELP_SETPOPUP_POS	Sets the position of the subsequent pop-up window.	Address of a POINTS structure. The pop-up window is positioned as if the mouse cursor were at specified point when the pop-up window is invoked.
HELP_SETWINPOS	Displays the Help window, if it is minimized or in memory, and sets its size and position as specified.	Address of a HELPWININFO structure that specifies the size and position of either a primary or secondary Help window.
HELP_TCARD	Indicates that a command is for a training card instance of the WinHelp program. A program combines the HELP_TCARD flag with other commands by using the bitwise OR operator.	Depends on the command with which the flag is combined.
HELP_WM_HELP	Displays, in a pop-up window, the topic for the control identified by hwnd.	Address of an array of double word pairs. The first double word in each pair is a control identifier, and the second is a context identifier for a topic.