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

Name Data type Required Description
VI Path cpath.png Yes

Path to the VI whose description you want to get.
VI Description istr.png Yes

Description of the VI.

Remarks

The following table lists the characteristics of this method.

Short Name Get VI.Description
Data type No return value
Available in Run-Time Engine Yes
Available in Real-Time Operating System Yes
Remote access allowed Yes