SystemHelp
- Updated2023-02-21
- 3 minute(s) read
SystemHelp
int SystemHelp (char helpFile[], unsigned int command, unsigned long additionalLongData, char additionalStringData[]);
Purpose
 |
Note The Windows Help viewer (winhelp.exe) is not included Windows. Use the ShowHtmlHelp function to launch a Windows HTML help file. |
Starts Windows Help, winhelp.exe, on a specified help file.
You can pass optional data that indicates the nature of the help you want to display.
For information about creating help files, refer to www.msdn.com.
(Linux) This function is not supported.
Parameters
| Input | ||
| Name | Type | Description |
| helpFile | char [] | The string containing the name of the help file you want to display. The pathname can be followed by an angle bracket (>) and the name of a secondary window if you want the topic to appear in a secondary window rather than in the primary window. The [WINDOWS] section of the help project (.hpj) file must define the name of the secondary window. |
| command | unsigned int | The type of help you want to display. You can specify the following values: HELP_COMMAND—Executes a help macro or macro string. In this case, additionalStringData is the help macro to execute. HELP_CONTENTS—Displays the help contents topic as defined by the contents option in the [OPTIONS] section of the .hpj file. HELP_CONTENTS is for backward compatibility. New programs should provide a .cnt file and use the HELP_FINDER command. HELP_CONTEXT—Displays help for a particular topic identified by a context number that has been defined in the [MAP] section of the .hpj file. In this case, additionalLongData is the context number of the topic. HELP_CONTEXTPOPUP—Displays in a pop-up window a particular help topic identified by a context number that has been defined in the [MAP] section of the .hpj file. HELP_CONTEXTPOPUP does not display the main help window. In this case, additionalLongData is the context number of the topic. HELP_FINDER—Displays the Help Topics dialog box. In the Help Topics dialog box, you can select topics to display by viewing the titles of the topics, the keywords associated with the topics, or the words and phrases found in the topics. HELP_HELPONHELP—Displays the contents topic of the Using Help file if it is available. HELP_KEY—Displays the topic in the keyword list that matches the keyword passed in the additionalStringData parameter if one exact match exists. If more than one match exists, HELP_KEY displays the Topics Found dialog box. HELP_PARTIALKEY—Displays the topic found in the keyword list that matches the keyword passed in the additionalStringData parameter if one exact match exists. If more than one match exists, HELP_PARTIALKEY displays the Topics Found dialog box. If you want to display the Index without passing a keyword, pass an empty string (""). HELP_POPUPID—Displays in a pop-up window the topic identified by a context string. HELP_POPUPID does not display the main help window. HELP_QUIT—Closes the help file. HELP_QUIT has no effect if another executable opens the help file. HELP_SETCONTENTS—Determines which Contents topic help appears when the user chooses the Contents button in a help window if the help file does not have an associated .cnt file. If a help file has two or more Contents topics, you must assign one as the default. Call SystemHelp with command set to HELP_SETCONTENTS and the additionalLongData parameter specifying the corresponding context identifier. |
| additionalLongData | unsigned long | Depends on the command parameter. HELP_CONTEXT—The context number of the topic. HELP_CONTEXTPOPUP—The context number of the topic. HELP_SETCONTENTS—The context number of the topic that is to be designated as the Contents topic. |
| additionalStringData | char [] | Depends on the command parameter. HELP_POPUPID—The context string of the topic to be displayed. HELP_KEY—The keyword for the requested topic. HELP_PARTIALKEY—The partial keyword for the requested topic. HELP_COMMAND—The help macro to be executed. |
Return Value
| Name | Type | Description |
| status | int | Nonzero on success; zero on failure. |
Additional Information
Library: Utility Library
Include file: utility.h
LabWindows/CVI compatibility: LabWindows/CVI 3.0 and later