VI class/Help.Document Path property

From LabVIEW Wiki
Jump to: navigation, search
VI Server Property Information
Property ID 215
Scope Basic Development Environment
Data Name Help.Path
Short Name* Help.Path
Long Name* Help:Document Path
* Displayed here in English. Short and Long names appear in the language of the LabVIEW IDE.
Owning Class ID 2
Owning Class Name VI Class
Data Type Path data type

Path

Property Node Help:Document Path
Available in Real-Time Operating SystemYes
Available in Run-Time EngineYes
Available with control VIsYes
Available with global VIsYes
Available with polymorphic VIsYes
Available with strict type definitionsNo
Loads the block diagram into memoryNo
Loads the front panel into memoryNo
Must wait until user interface is idleNo
Need to authenticate before useNo
PermissionsRead/Write
Remote access allowedYes
Settable when the VI is runningYes

Path or symbolic path to an HTML file (.htm or .html) or compiled help file (.chm or .hlp) to which the VI is linked.

If the path is to a compiled help file, use the Document Tag property to determine the specific topic in that help file.

This property is similar to the Help Path text box on the Documentation page of the VI Properties dialog box.


Uses

History

Version Change(s)
LabVIEW 2018 More info to come.

See Also

External Links