niWLANG_CreateAndWriteWaveformsToFile

NI WLAN Generation Toolkit 18.0 Help

Edition Date: October 2018

Part Number: 373725J-01

»View Product Info
Download Help (Windows Only)

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

Purpose

Creates waveforms according to the properties configured in an niWLAN generation session and saves the waveforms to a file. In addition to creating the waveform, this function also saves the NIWLANG_HEADROOM and NIWLANG_IQ_RATE attributes for each waveform. The function reads the NIWLANG_RF_BLANKING_MARKER_POSITIONS attribute and saves the value to the file. The NIWLANG_RF_BLANKING_MARKER_POSITIONS attribute stored in the file is applicable to all waveforms stored in the file. Additionally, this function saves the NIWLANG_SIGNAL_BANDWIDTH attribute for each waveform, which is computed as:

Signal Bandwidth = 2* {(Channel Bandwidth/2) + |Max Carrier Frequency Offset|}

Parameters

Input
Name Type Description
session niWLANGenerationSession Specifies the niWLAN generation session.
filePath char[] Specifies the absolute path to the TDMS file to which the toolkit writes the waveforms.
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 a file if it exists.
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

WAS THIS ARTICLE HELPFUL?

Not Helpful