NI Bluetooth Analysis Toolkit

niBTSA_SaveConfigurationToFile

  • Updated2023-02-21
  • 1 minute(s) read

int32 __stdcall niBTSA_SaveConfigurationToFile (niBTSASession session, char[] filePath, int32 operation);

Purpose

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

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

Parameters

Input
Name Type Description
session niBTSASession Specifies the niBT SA session. Use this parameter to configure the behavior and operation of the appropriate NI Bluetooth Analysis Toolkit function that accepts the niBTSASession as an input.
filePath char[] Specifies the absolute path to the TDMS file to which the toolkit saves the configuration.
operation int32 Specifies the operation to perform on the file. The default value is NIBTSA_FILE_OPERATION_MODE_CREATEORREPLACE.
NIBTSA_FILE_OPERATION_MODE_OPEN(0) Opens an existing file to write the niBT SA session property values.
NIBTSA_FILE_OPERATION_MODE_OPENORCREATE(1) Opens an existing file or creates a new file if the file does not exist.
NIBTSA_FILE_OPERATION_MODE_CREATEORREPLACE(2) Creates a new file or replaces a file if it exists.
NIBTSA_FILE_OPERATION_MODE_CREATE(3) Creates a new file.

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 niBT SA 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 niBTSA_GetErrorString function.

The general meaning of the status code is as follows:

Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

Log in to get a better experience