niRFSA_GetRelayName
- Updated2024-05-08
- 2 minute(s) read
niRFSA_GetRelayName
ViStatus niRFSA_GetRelayName(ViSession vi, ViConstString channelList, ViInt32 index, ViChar name[], ViInt32* bufferSize);
Purpose
Returns the name of a relay for your device. When you call this function and pass a VI_NULL pointer to the name parameter, bufferSize is populated with the size of name including the terminating NULL byte. When you call this function and specify a value for bufferSize that is greater than or equal to the name of relay, the name parameter returns the appropriate value.
Supported Devices: PXIe-5603/5605/5606.
Parameters
| Input | ||
| Name | Type | Description |
| vi | ViSession | Identifies your instrument session. vi is obtained from the niRFSA_init or niRFSA_InitWithOptions function. |
| channelList | ViConstString | Identifies which channels to apply settings. Specify an empty string as the value of this parameter. |
| indexOfRelay | ViInt32 | Specifies the index of the relay. |
| Output | ||
| Name | Type | Description |
| name | ViChar[] | Specifies the relay name, when used as an input. You can select VI_NULL or a pointer to a ViInt32 array. VI_NULL is the default. When bufferSize is greater than or equal to the number of relays, name returns the relay name. |
| bufferSize | ViInt32* | When a VI_NULL pointer is passed in for the name, bufferSize is populated with the size of the name. |
Return Value
| Name | Type | Description | ||||||||
| status | ViStatus | Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an NI-RFSA function to determine if an error has occurred. To obtain a text description of the status code and additional information about the error condition, call the niRFSA_GetError function. To clear the error information from NI-RFSA, call the niRFSA_ClearError function. The general meaning of the status code is as follows:
|
||||||||