RFmxInstr_SaveAllConfigurations

NI-RFmx GSM 2.5 Help

Edition Date: June 2018

Part Number: 375416F-01

»View Product Info
Download Help (Windows Only)

int32 __stdcall RFmxInstr_SaveAllConfigurations(niRFmxInstrHandle instrumentHandle, char filePath[]);

Purpose

Saves all the configured properties in the RFmx session to a file in the specified file path. Use this function to save the current state of the RFmx session.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxInstr_Initialize function.
filePath char[] Specifies the complete path to the technical data management streaming (TDMS) file to which the configurations are to be saved.

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. 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

WAS THIS ARTICLE HELPFUL?

Not Helpful