VI class/Get Control Index by Name method

From LabVIEW Wiki
Jump to: navigation, search
VI Server Method Information
Method ID 4A7
Scope Basic Development Environment
Data Name GetControlIndexByName
Short Name* GetControlIndexByName
Long Name* Get Control Index by Name
* 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 I32 data type


Invoke Node Get Control Index by Name
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 index for the control or indicator of the given name. If the control or indicator for which you want to get an index does not have a terminal on the block diagram, this method returns an error.

You can use this method to specify the controls for which you get or set values with the Get Control Values by Index or Set Control Values by Index functions.


Data type Name Required Description
I32 Get Control Index by Name Yes. Return value.
String Control Name Yes Specifies the name of the control or indicator for which LabVIEW retrieves an index.



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

See Also

External Links