Reads values of session attributes (configuration) saved in a file and sets these values to the corresponding attributes on the session, thus restoring the state of the BT Generation to the original state when the file was saved.

Syntax

int32 __stdcall niBTSG_LoadConfigurationFromFile(niBTSGSession session, ViChar filePath, int32 reset)

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 file from which the BT Generation loads the configuration.

reset[in]int32

Specifies whether BT Generation must reset all the attributes of the session to their default values before setting the new values specified in the file. The default value is NIBTSG_VAL_TRUE.

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