Application class/Get VI.Description method

From LabVIEW Wiki
Jump to: navigation, search
VI Server Method Information
Method ID 806
Scope Basic Development Environment
Data Name Get VI.Description
Short Name* Get VI.Description
Long Name* Get VI:Description
* Displayed here in English. Short and Long names appear in the language of the LabVIEW IDE.
Owning Class ID 1
Owning Class Name Application Class
Return Data Type No return value
Invoke Node Get VI:Description
Available in Real-Time Operating SystemYes
Available in Run-Time EngineYes (Read/Write)
Remote access allowedYes

Returns the description stored in the VI description field on the Documentation page of the VI Properties dialog box for the specified VI. Unlike the VI Description property, this method does not load the VI into memory.

Parameters

Data type Name Required Description
Path VI Path Yes Path to the VI whose description you want to get.
String VI Description Yes Description of the VI.

Uses

History

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

See Also

External Links