RFmxNR_InitializeFromNIRFSASession
- Updated2025-04-08
- 1 minute(s) read
Creates an RFmx session from an existing NI-RFSA session. This function resets all the NI-RFSA attributes to their default values and stops export of all external signals and events. This function takes in an active NI-RFSA instrument handle and returns an RFmx Handle Out that identifies the device in all the subsequent RFmx functions.
Syntax
int32 __stdcall RFmxNR_InitializeFromNIRFSASession(uInt32 nirfsaSession, niRFmxInstrHandle *handleOut)
Remarks
This function is a wrapper over the RFmx Instruments API, and calls the RFmxInstr_InitializeFromNIRFSASession function.
Parameters
Name | Direction | Type | Description |
---|---|---|---|
nirfsaSession | [in] | uInt32 | Specifies the NIRFSA session handle of the device to initialize. |
handleOut | [out] | niRFmxInstrHandle * | Returns an RFmx instrument session. |
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 RFmxNR_GetError function.
The general meaning of the status code is as follows:
Value | Meaning |
---|---|
0 | Success |
Positive Values | Warnings |
Negative Values | Errors |