Control Online Help Function

Owning Palette: Help VI and Functions

Requires: Base Development System

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.

(Real-Time Module) You cannot use this function in VIs that run on RT targets.

Add to the block diagram

Find on the palette

	Operation is the operation to perform on the help file. 0 Contents—Displays the table of contents of the help file. If you use this function to control a .chm file, setting this input to 0 displays the table of contents, index, or search tab, depending on which tab was visible the last time you closed the .chm file. 1 Key—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. 2 Close—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 or symbolic path to the compiled help file you want to control. The help file can have a .chm or .hlp extension. (macOS and Linux) 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\help.chm directory where help.chm is the filename you wire to this input, 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 node runs. This input provides standard error in functionality.
	error out contains error information. This output provides standard error out functionality.