RFmxGSM_InitializeFromNIRFSASession

RFmx GSM 19.1 Help

Edition Date: October 2019

Part Number: 375414H-01

»View Product Info

DOWNLOAD (Windows Only)


RFmx GSM 19.1 Help
RFmx GSM 20.0 Help

int32 __stdcall RFmxGSM_InitializeFromNIRFSASession (uInt32 NIRFSASession, niRFmxInstrHandle *handleOut);

Purpose

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. This function is a wrapper over the RFmx Instruments API, and calls the RFmxInstr_InitializeFromNIRFSASession function.

Parameters

Input
Name Type Description
NIRFSASession uInt32 Specifies the NIRFSA session handle of the device to initialize.
Output
Name Type Description
handleOut niRFmxInstrHandle* Returns an RFmx instrument session.

Return Value

Name Type Description
status int32 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 RFmxGSM_GetError function.

The general meaning of the status code is as follows:

Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

WAS THIS ARTICLE HELPFUL?

Not Helpful