WinHelp_InvokeHelp()

The WinHelp_InvokeHelp() function starts the help engine, indicating the help file, help command, and context number (a long integer) to be used.

Syntax

WinHelp_InvokeHelp(help_file, help_command, context_number)

Parameters

• help_file – A string containing the name and complete path to the help file to be accessed. The path is in generic format.

• help_command – An integer indicating how help is to be invoked. The integer corresponds to one of the following constants.

Constant	Command
HELP_CMD_CONTENTS	Display help contents topic.
HELP_CMD_CONTEXT	Display context-sensitive help in a standard help window.
HELP_CMD_CONTEXTPOPUP	Display context-sensitive help in a pop-up window. This is available only for Windows Help.

• context_number – A long integer indicating which help topic to display. If the help contents topic is being displayed, this parameter should be set to 0.

Return value

An integer indicating the status. If 0 is returned, no error occurred. If any other value is returned, an error occurred while invoking help.