VI class/Control Value.Get All method

From LabVIEW Wiki
Jump to: navigation, search
VI Server Method Information
Method ID 41D
Scope Basic Development Environment
Data Name Ctrl Val.Get All
Short Name* Ctrl Val.Get All
Long Name* Control Value:Get All
* Displayed here in English. Short and Long names appear in the language of the LabVIEW IDE.
Owning Class ID 2
Owning Class Name VI Class
Return Data Type Common Cluster Array data type

Common Cluster Array

Invoke Node Control Value:Get All
Available in Real-Time Operating SystemYes
Available in Run-Time EngineYes (Read/Write)
Available with control VIsYes
Available with global VIsYes
Available with polymorphic VIsNo
Available with strict type definitionsNo
Loads the block diagram into memoryNo
Loads the front panel into memoryNo
Must wait until user interface is idleNo
Need to authenticate before useNo
Remote access allowedYes
Settable when the VI is runningYes

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 type Name Required Description
Common Cluster Array Control Value:Get All Yes. Return value.
Boolean Controls No If TRUE, the method returns values for all the controls. If FALSE (default), the method returns values for all the indicators.

Uses

History

Version Change(s)
LabVIEW 2018 More info to come.

See Also

External Links