Loads the attributes of an RFmx session saved in a file. This file can be generated using RFmxInstr_SaveAllConfigurations function or using the RF Signal Analyzer panel in InstrumentStudio.

Syntax

int32 __stdcall RFmxInstr_LoadConfigurations(niRFmxInstrHandle instrumentHandle, char filePath[])

Remarks

You can specify the configurations to skip while loading from a file using the RFMXINSTR_ATTR_LOAD_OPTIONS attribute.
Note

If the file contains a named signal configuration which is already present in the session, then this function will return an error. NI recommendeds to call the RFmxInstr_ResetEntireSession function to delete all the named signal configurations in the session.

Parameters

NameDirectionTypeDescription
instrumentHandle[in]niRFmxInstrHandle

This parameter identifies the instrument session. This parameter is obtained from the RFmxInstr_Initialize function or the RFmxInstr_InitializeFromNIRFSASessionArray function.

filePath[in]char[]

This parameter specifies the complete path to the file from which the configurations are to be loaded. Default file extension: .rfmxconfig

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