Get VI:Bookmarks Method

Short Name: Get VI.Bookmarks

Requires: Base Development System

Class: Application Methods

To Use: Create a method.

Returns the bookmark information for the VI specified in VI Path. You do not need to load the VI into memory in order to read the bookmark information. This method returns an error if the VI is password protected, if the VI is saved in an earlier version of LabVIEW and is not currently in memory, or if the VI does not have a block diagram.

Parameters

Data typeNameRequiredDescription
VI PathYesPath to the VI whose help information you want to get.
Bookmark InformationNoArray of clusters that contain the bookmark ID, the bookmark tag, and the full text of the label.

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