RFmxInstr_InitializeFromNIRFSASessionArray
- Updated2025-10-13
- 1 minute(s) read
Initializes an RFmx session from existing NI-RFSA sessions. This function resets all NI-RFSA attributes to their default values and stops export of all the external signals and events. This function also takes in active NI-RFSA sessions and returns an RFmx Handle that identifies devices in all subsequent RFmx functions.
Syntax
int32 __stdcall RFmxInstr_InitializeFromNIRFSASessionArray(uInt32 nirfsaSessions[], int32 numberOfNIRFSASessions, niRFmxInstrHandle *handleOut)
Parameters
| Name | Direction | Type | Description |
|---|---|---|---|
| nirfsaSessions | [in] | uInt32[] | This parameter identifies the NI-RFSA sessions. |
| numberOfNIRFSASessions | [out] | int32 | Specifies the number of NI-RFSA sessions. |
| handleOut | [out] | niRFmxInstrHandle * | This parameter passes a reference of the RFmx session to the next function. |
Returns
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 RFmx 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 RFmxInstr_GetError function.
The general meaning of the status code is as follows:
Value | Meaning |
|---|---|
0 | Success |
Positive Values | Warnings |
Negative Values | Errors |