Control Value:Get All Method

Short Name: Ctrl Val.Get All

Requires: Base Development System

Class: VI Methods

To Use: Create a method.

Gets the values of all controls or indicators in a VI as variant data. This method returns an array of clusters that contains control and indicator names and their values as variant data. Use the Variant to Data function to convert the data to another LabVIEW data type.

Note  This method requires the VI to have a front panel. If you are using the Application Builder, make sure you do not remove the front panel.

For optimization purposes, LabVIEW does not keep track of data values on controls and indicators until LabVIEW determines you want them, that is, until you call this method or display the front panel. When you display the front panel, LabVIEW begins keeping track of the values.

The first time you call this method on a VI whose front panel is not open, this method returns the default values of the control or indicator rather than the actual values. Thereafter, it returns the actual value.

Parameters

Data typeNameRequiredDescription
ControlsNoIf TRUE, the method returns values for all the controls. If FALSE (default), the method returns values for all the indicators.

Remarks

The following table lists the characteristics of this method.

Data type
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 VIsYes
Available with strict type definitionsNo
Available with polymorphic VIsNo