VI class/Get Control Index by Name method
< VI class
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 | |
Available in Real-Time Operating System | Yes |
Available in Run-Time Engine | Yes (Read/Write) |
Available with control VIs | Yes |
Available with global VIs | Yes |
Available with polymorphic VIs | No |
Available with strict type definitions | No |
Loads the block diagram into memory | No |
Loads the front panel into memory | No |
Must wait until user interface is idle | No |
Need to authenticate before use | No |
Remote access allowed | Yes |
Settable when the VI is running | Yes |
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.
Parameters
Data type | Name | Required | Description |
---|---|---|---|
Get Control Index by Name | Yes. Return value. | ||
Control Name | Yes | Specifies the name of the control or indicator for which LabVIEW retrieves an index. |
Uses
Specific use cases for this method. |
History
History information is needed. What changes have occurred over previous versions? |
Version | Change(s) |
---|---|
More info to come. |
See Also
Add links to internal wiki pages that would also help. |
External Links
Add links to external resources that would also help. |