Get VI:Help Info Method

LabVIEW 2018 Help


Edition Date: March 2018
Part Number: 371361R-01
View Product Info

DOWNLOAD (Windows Only)


LabVIEW 2016 Help
LabVIEW 2017 Help
LabVIEW 2018 Help
LabVIEW 2019 Help
LabVIEW 2020 Help

Short Name: Get VI.Help Info

Requires: Base Development System

Class: Application Methods

To Use: Create a method.

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

Data typeNameRequiredDescription
VI PathYesPath to the VI whose help information you want to get.
VI Help PathNoHelp path of the VI. The help path is located on the Documentation page of the VI Properties dialog box.
VI Help TagNoHelp 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 URLNoWeb-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 URLNoIndicates 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.

Data typeNo return value
Available in Run-Time EngineYes (Read/Write)
Available in Real-Time Operating SystemYes
Remote access allowedYes

WAS THIS ARTICLE HELPFUL?

Not Helpful