Get VI:Description Method

LabVIEW 2018 Help

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

DOWNLOAD (Windows Only)

LabVIEW 2015 Help
LabVIEW 2016 Help
LabVIEW 2017 Help
LabVIEW 2018 Help
LabVIEW 2019 Help

Short Name: Get VI.Description

Requires: Base Development System

Class: Application Methods

To Use: Create a method.

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.


Data typeNameRequiredDescription
VI PathYesPath to the VI whose description you want to get.
VI DescriptionYesDescription of the VI.


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


Not Helpful