Syntax

Engine.DisplayHelpTopic( tagID, helpFile = "", tableOfContentsFile = "", indexFile = "", homeFile = "", windowCaption = "")

Return Value

Long

Returns the window handle of the created help window.

Purpose

Opens to a topic in a HTML Help file using a help ID.

Remarks

Uses the assigned help ID to open the compiled help file ( .chm ) to a particular topic. 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 these parameters are specified, 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.

To specify that a file is within a CHM, use the following syntax:

CHMFileName.chm::\\FileName. xxx

If TestStand helpFile is passed, then the help content will be opened by NI Help Launcher by calling into Engine.DisplayHelpTopicEx API.

Parameters

tagID As Long

[In] Specifies the help ID of the help topic within the compiled help file to open. The help file author associates help IDs with topic files.

Pass 0 to open the help file to the default topic.

helpFile As String

[In] Specifies the name of the HTML help file to open. Include the absolute path of the help file and the extension. If you do not specify a help file, TestStand uses the NI TestStand Help .

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. Include the absolute path of the table of contents file along with the 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. Include the absolute path of the index file along with the 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. Include the absolute path of the default topic along with the 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, the help window caption is the caption the author of the help file specifies. If you specify a contents file or an index file but do not specify this parameter, the window caption defaults to NI TestStand Help .

This parameter has a default value of "" .

See Also

Engine.DisplayHelpFile