niRFSA_GetRelayOperationsCount
- Updated2024-05-08
- 2 minute(s) read
niRFSA_GetRelayOperationsCount
ViStatus niRFSA_GetRelayOperationsCount(ViSession vi, ViConstString channelList, ViInt32 operationsCount[], ViInt32* bufferSize);
Purpose
Returns an array consisting of all the relay counts for your device. When you call this function and pass a VI_NULL pointer to the operationsCount parameter, bufferSize is populated with the number of relays on the device. When you call this function and specify a value for bufferSize that is greater than or equal to the number of relays, the operationsCount parameter returns the appropriate value.
Supported Devices: PXIe-5603/5605/5606, PXIe-5698
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. |
| Output | ||
| Name | Type | Description |
| operationsCount | ViInt32[] | Specifies the operations count array, 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, operationsCount returns the number of relay operations. |
| bufferSize | ViInt32* | Functions as an input or an output. bufferSize receives or returns the number of relays that are on the device. |
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:
|
||||||||