Get VI:Help Info
- Updated2026-02-04
- 2 minute(s) read
Returns Help path, Help tag, Help Used, and Help URL from the Documentation page of the VI Properties dialog box for the specified VI. This method does not load the VI into memory.
Parameters
| Name | Data type | Required | Description |
|---|---|---|---|
| VI Path |  |
Yes | Path to the VI whose help information you want to get. |
| VI Help Path |  |
No | Help path of the VI. The help path is located on the Documentation page of the VI Properties dialog box. |
| VI Help Tag |  |
No | Help tag of the VI. The help tag links a VI to a specific topic within a compiled help file or links a VI to a bookmark within an HTML help file. The help tag is located on the Documentation page of the VI Properties dialog box. |
| VI Help Web URL | |
No | Web-based URL of the help file for the VI. The help URL is located on the Documentation page of the VI Properties dialog box. |
| Use Web URL |  |
No | Indicates whether to link to a web-based help file from the Detailed help link in theContext Help window for a VI.Web URL is located on the Documentation page of the VI Properties dialog box. |
Remarks
The following table lists the characteristics of this method.
| Short Name | Get VI.Help Info |
| Data type | No return value |
| Available in Run-Time Engine | Yes |
| Available in Real-Time Operating System | Yes |
| Remote access allowed | Yes |