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

niWLANG_SetOFDMDataRate

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_SetOFDMDataRate (niWLANGenerationSession session, char channelString[], int32 ofdmDataRate);

Purpose

Specifies the data rate for the OFDM payload, as defined in section 17.3.2.2 of IEEE Standard 802.11a-1999. This value is expressed is Mbps.

Note  Configure this function only when you set the NIWLANG_STANDARD attribute to NIWLANG_VAL_STANDARD_80211AG_OFDM, NIWLANG_VAL_STANDARD_80211J_OFDM, NIWLANG_VAL_STANDARD_80211P_OFDM or NIWLANG_VAL_STANDARD_80211G_DSSS_OFDM.

Parameters

Input
Name Type Description
session niWLANGenerationSession Specifies the niWLAN generation session.
channelString char[] Set this parameter to "" (empty string) or NULL.
ofdmDataRate int32

Specifies the data rate for the OFDM payload. This value is expressed in Mbps. The default value is NIWLANG_VAL_OFDM_DATA_RATE_6.

NIWLANG_VAL_OFDM_DATA_RATE_6 (0) Specifies a data rate of 1.5 Mbps, 3 Mbps, and 6 Mbps for respective channel bandwidths of 5 MHz, 10 MHz, and 20 MHz.
NIWLANG_VAL_OFDM_DATA_RATE_9 (1) Specifies a data rate of 2.25 Mbps, 4.5 Mbps, and 9 Mbps for respective channel bandwidths of 5 MHz, 10 MHz, and 20 MHz.
NIWLANG_VAL_OFDM_DATA_RATE_12 (2) Specifies a data rate of 3 Mbps, 6 Mbps, and 12 Mbps for respective channel bandwidths of 5 MHz, 10 MHz, and 20 MHz.
NIWLANG_VAL_OFDM_DATA_RATE_18 (3) Specifies a data rate of 4.5 Mbps, 9 Mbps, and 18 Mbps for respective channel bandwidths of 5 MHz, 10 MHz, and 20 MHz.
NIWLANG_VAL_OFDM_DATA_RATE_24 (4) Specifies a data rate of 6 Mbps, 12 Mbps, and 24 Mbps for respective channel bandwidths of 5 MHz, 10 MHz, and 20 MHz.
NIWLANG_VAL_OFDM_DATA_RATE_36 (5) Specifies a data rate of 9 Mbps, 18 Mbps, and 36 Mbps for respective channel bandwidths of 5 MHz, 10 MHz, and 20 MHz.
NIWLANG_VAL_OFDM_DATA_RATE_48 (6) Specifies a data rate of 12 Mbps, 24 Mbps, and 48 Mbps for respective channel bandwidths of 5 MHz, 10 MHz, and 20 MHz.
NIWLANG_VAL_OFDM_DATA_RATE_54 (7) Specifies a data rate of 13.5 Mbps, 27 Mbps, and 54 Mbps for respective channel bandwidths of 5 MHz, 10 MHz, and 20 MHz.

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