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


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_RFSGCreateAndDownloadWaveform (niWLANGenerationSession session, ViSession rfsgSession, char hwChannelString[], char waveformName[]);


Creates a single channel waveform, writes it into the RFSG memory, and stores the I/Q rate, the burst start locations, the burst stop locations, the waveform size, and the actual headroom of the waveform in the RFSG database. Use this instance if the NIWLANG_STANDARD attribute is set to NIWLANG_VAL_STANDARD_80211AG_OFDM, NIWLANG_VAL_STANDARD_80211J_OFDM, NIWLANG_VAL_STANDARD_80211P_OFDM, NIWLANG_VAL_STANDARD_80211BG_DSSS, or NIWLANG_VAL_STANDARD_80211G_DSSS_OFDM.

Inside the niWLANG_CreateAndDownloadWaveform function, all the following operations that involve NI-RFSG are performed on the device. The niWLANG_CreateAndDownloadWaveform function completes the following operations:

  1. Sets the NIWLANG_MAXIMUM_HARDWARE_IQ_RATE attribute according to the device model. You must set the value of the NIWLANG_MAXIMUM_HARDWARE_IQ_RATE attribute to 1250 MS/s if you are using the NI PXIe-5840, 250 MS/s if you are using the NI PXIe-5646R, 120 Ms/s if you are using the NI PXIe-5644R/5645R, and 200 MS/s if you are using the NI PXIe-5673/5673E.
  2. Reads the NIWLANG_IQ_RATE attribute, and sets the NIRFSG_ATTR_IQ_RATE attribute to the value specified in the NIWLANG_IQ_RATE attribute. The value is stored in the RFSG database for the waveform and device.
  3. Sets the NIRFSG_ATTR_RF_BLANKING_SOURCE attribute to NIRFSG_VAL_MARKER0 (if it is not set already), if the NIWLANG_RF_BLANKING_ENABLED attribute is set to NIWLANG_VAL_TRUE and the device model is the NI PXIe-5644R, NI PXIe-5645R, NI PXIe-5646R, or NI PXIe-5840.
  4. Reads and stores the NIWLANG_BURST_START_LOCATIONS attribute, NIWLANG_BURST_STOP_LOCATIONS attribute and the waveform size in the RFSG database.
  5. Creates the WLAN waveform and downloads it to device.
  6. Stores the NIWLANG_ACTUAL_HEADROOM attribute to the RFSG database.


Name Type Description
session niWLANGenerationSession Specifies the niWLAN generation session.
rfsgSession ViSession Identifies the instrument session. The toolkit obtains this parameter from the niRFSG_init function or the niRFSG_InitWithOptions function.
hwChannelString char[] Specifies the RF vector signal generator channel. Set this parameter to "" (empty string) or NULL.
waveformName char[] Specifies the name used to write the waveform to NI-RFSG device memory and store its attributes to RFSG database. This string is case-insensitive, alphanumeric, and does not use reserved words.

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