Get VI Bookmarks Method

Short Name: GetVIBookmarks

Requires: Base Development System

Class: VI Methods

To Use: Create a method.

Returns the bookmark information for the specified VI reference. You must load the VI into memory in order to read the bookmark information. This method returns an error if the VI is password protected or if the VI does not have a block diagram.

Parameters

Data typeNameRequiredDescription
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
Settable when the VI is runningYes
Loads the front panel into memoryNo
Need to authenticate before useNo
Loads the block diagram into memoryNo
Remote access allowedYes
Must wait until user interface is idleNo
Available with control VIsYes
Available with global VIsNo
Available with strict type definitionsNo
Available with polymorphic VIsNo