Control Online Help

Controls a compiled help file by displaying the table of contents, jumping to a specific topic in the file, or closing the help file. You can create a compiled help file and use this function to link from a VI to the help file. You also can use this function to display an HTML file in the default browser.

Operation is the operation to perform on the help file.

0Contents—Displays the table of contents of the help file.
1Key—Displays a specific topic in the help file using a keyword in the help file index or using the name of an individual HTML file in the compiled help file.
2Close—Closes the help file.
String to search for is the index keyword or HTML filename for the topic in the help file that you want to display. The default is an empty string. LabVIEW ignores this string if Operation is 0 or 2.

If this string contains an index keyword, the string must match the index keyword as it appears in the help file index. To jump to a topic with a multi-level index keyword, enter the first-level index keyword, a colon, and the second-level index keyword. Do not separate the elements with spaces. For example, a error codes:GPIB string jumps to a topic with a first-level index keyword of error codes and a second-level index keyword of GPIB.

If Path to the help file contains a path to an HTML Help (.chm) file, this string can contain the filename (.htm or .html) of an individual HTML file in the HTML Help project.

Path to the help file is the path to the compiled help file you want to control. The help file can have a .chm or .hlp extension. Macintosh and UNIX If this input contains a path to a .chm file and the file does not exist, LabVIEW ignores this input. However, if String to search for contains an HTML filename and that HTML file is in the help\html directory, LabVIEW displays that HTML file in the default browser. If this input contains a path to a .chm file and String to search for contains an index keyword, this function does not display an HTML file.
error in describes error conditions that occur before this VI or function runs. The default is no error. If an error occurred before this VI or function runs, the VI or function passes the error in value to error out. This VI or function runs normally only if no error occurs before this VI or function runs. If an error occurs while this VI or function runs, it runs normally and sets its own error status in error out. Use the Simple Error Handler or General Error Handler VIs to display the description of the error code. Use error in and error out to check errors and to specify execution order by wiring error out from one node to error in of the next node.
status is TRUE (X) if an error occurred before this VI or function ran or FALSE (checkmark) to indicate a warning or that no error occurred before this VI or function ran. The default is FALSE.
code is the error or warning code. The default is 0. If status is TRUE, code is a non-zero error code. If status is FALSE, code is 0 or a warning code.
source describes the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning. The default is an empty string.
error out contains error information. If error in indicates that an error occurred before this VI or function ran, error out contains the same error information. Otherwise, it describes the error status that this VI or function produces. Right-click the error out indicator on the front panel and select Explain Error from the shortcut menu for more information about the error.
status is TRUE (X) if an error occurred or FALSE (checkmark) to indicate a warning or that no error occurred.
code is the error or warning code. If status is TRUE, code is a non-zero error code. If status is FALSE, code is 0 or a warning code.
source describes the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning.