Saves attributes of the session, which you may have modified after opening the session, to a file located at the specified path.

Syntax

int32 __stdcall niBTSG_SaveConfigurationToFile(niBTSGSession session, ViChar filePath, int32 operation)

Remarks

You can use this function to save the current state of the BT Generation session to a file. You can later load the saved configuration using the niBTSG_LoadConfigurationFromFile function.

Parameters

NameDirectionTypeDescription
session[out]niBTSGSession

Specifies the niBT SG session. Use this parameter to configure the behavior and operation of the appropriate RFmx BT Generation function that accepts the niBTSGSession as an input.

filePath[out]ViChar

Specifies the absolute path to the TDMS file to which the BT Generation saves the configuration.

operation[in]int32

Specifies the operation to perform on the file. The default value is NIBTSG_FILE_OPERATION_MODE_CREATEORREPLACE.

NIBTSG_FILE_OPERATION_MODE_OPEN(0)

Opens an existing file to write the niBT SG session attribute values.

NIBTSG_FILE_OPERATION_MODE_OPENORCREATE(1)

Opens an existing file or creates a new file if the file does not exist.

NIBTSG_FILE_OPERATION_MODE_CREATEORREPLACE(2)

Creates a new file or replaces an existing file.

NIBTSG_FILE_OPERATION_MODE_CREATE(3)

Creates a new file.

Returns

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 niBT SG 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 niBTSG_GetErrorString function. The general meaning of the status code is as follows:

Value

Meaning

0

Success

Positive Values

Warnings

Negative Values

Errors