Company Events Academic Community Support Solutions Products & Services Contact NI MyNI

niWLANG_SaveConfigurationToFile

NI WLAN Generation Toolkit 17.0 Help

Edition Date: May 2017

Part Number: 373725G-01

»View Product Info
Download Help (Windows Only)

int32 __stdcall niWLANG_SaveConfigurationToFile (niWLANGenerationSession session, char filePath[], int32 operation);

Purpose

Saves all attributes of the session to a file located at a specified path. Use this file to save the current state of the toolkit.

Parameters

Input
Name Type Description
session niWLANGenerationSession Specifies the niWLAN generation session.
filePath char[] Specifies the complete 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 NIWLANG_VAL_FILE_OPERATION_MODE_CREATE_OR_REPLACE.

NIWLANG_VAL_FILE_OPERATION_MODE_OPEN(0) Opens an existing file to write the niWLANG settings.
NIWLANG_VAL_FILE_OPERATION_MODE_OPEN_OR_CREATE(1) Opens an existing file or creates a new file if the file does not exist.
NIWLANG_VAL_FILE_OPERATION_MODE_CREATE_OR_REPLACE(2) Creates a new file or replaces an existing file.
NIWLANG_VAL_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 condition. Examine the status code from each call to the function to determine if an error occurred.

To obtain a text description of the status code, call the niWLANG_GetErrorString function.

The general meaning of the status code is as follows:

Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

 

Your Feedback! poor Poor  |  Excellent excellent   Yes No
 Document Quality? 
 Answered Your Question? 
Add Comments 1 2 3 4 5 submit