DisplayHelpFile Method
Syntax
Engine.DisplayHelpFile ( htmlFile, helpFile = "", tableOfContentsFile = "", indexFile = "", homeFile = "", windowCaption = "")
Return Value
Returns the window handle (HWND) of the created help window.
Purpose
Opens to a topic in a HTML Help file using the topic file name, such as Engine.htm.
Remarks
Opens the HTML Help window to a given topic within the compiled help file (.chm) using the help topic's file name. If any of the following parameters are specified—tableOfContentsFile, indexFile, or homeFile—then all three are used to build the HTML Help window. If none of the following parameters are specified—tableOfContentsFile, indexFile, and homeFile—then the information stored in the help file is used to build the HTML Help window.
To ensure proper navigation within the opened help file, National Instruments recommends that all three parameters—tableOfContentsFile, indexFile, and homeFile—be specified together.
Parameters
htmlFile As String
[In] Specifies the name of the HTML help topic within the help file to which the help window is opened. Make sure to include the file extension (.htm, .html) of the page. Specify the entire path of the page within the help file.
Pass "" to open the help file to the default topic.
helpFile As String
[In] Specifies the name of the HTML help file to open. Make sure to include the complete path of the help file and its extension. If no help file is specified, the TestStand help file is used.
This parameter has a default value of "".
tableOfContentsFile As String
[In] Specifies the name of the table of contents file to use with the help file. Make sure to include the complete path of the table of contents file along with its extension.
This parameter has a default value of "".
indexFile As String
[In] Specifies the name of the index file to use with the help file. Make sure to include the complete path of the index file along with its extension.
This parameter has a default value of "".
homeFile As String
[In] Specifies the name of the default topic to display for the help file. Make sure to include the complete path of the default topic along with its extension.
This parameter has a default value of "".
windowCaption As String
[In] Specifies the help window caption to display. This parameter is ignored unless a table of contents file, an index file, or a default topic file is specified. If none of these files are specified, then the help window caption is the caption specified by the author of the help file.
This parameter has a default value of "".