niWLANA_GetACPUpperAbsolutePower
- Updated2023-02-21
- 2 minute(s) read
int32 __stdcall niWLANA_GetACPUpperAbsolutePower (niWLANAnalysisSession session, char channelString[], float64 dataArray[], int32 dataArraySize, int32 *actualNumDataArrayElements);
Purpose
Returns the power in the upper offset channels measured over the bandwidth specified by the NIWLANA_CHANNEL_BANDWIDTH attribute. The number of offset channels is specified by the NIWLANA_ACP_NUMBER_OF_OFFSETS attribute. This value is expressed in dBm. The elements in the array are in the order of increasing frequency separation with respect to the reference channel.
You must use the following active channel string formats to query this function.
| NIWLANA_STANDARD attribute setting | Active channel string syntax |
|---|---|
| NIWLANA_VAL_STANDARD_80211AG_OFDM, NIWLANA_VAL_STANDARD_80211J_OFDM, NIWLANA_VAL_STANDARD_80211P_OFDM, NIWLANA_VAL_STANDARD_80211BG_DSSS, NIWLANA_VAL_STANDARD_80211G_DSSS_OFDM | "" (empty string) |
| NIWLANA_VAL_STANDARD_80211N_MIMO_OFDM, NIWLANA_VAL_STANDARD_80211AH_MIMO_OFDM | "channelx" |
| NIWLANA_VAL_STANDARD_80211AC_MIMO_OFDM , NIWLANA_VAL_STANDARD_80211AF_MIMO_OFDM , NIWLANA_VAL_STANDARD_80211AX_MIMO_OFDM | "[segmentx/]channely" ("segment0/" is optional if the NIWLANA_NUMBER_OF_SEGMENTS is set to 1) |
Parameters
| Input | ||
| Name | Type | Description |
| session | niWLANAnalysisSession | Specifies the niWLAN analysis session refnum. |
| channelString | char[] | Specifies the active channel string. |
| dataArraySize | int32 | Specifies the number of elements in the data array. |
| Output | ||
| Name | Type | Description |
| dataArray | float64[] | Returns the power in the upper offset channels measured over the bandwidth specified by the NIWLANA_CHANNEL_BANDWIDTH attribute. This value is expressed in dBm. |
| actualArraySize | int32* | Returns the number of elements in the dataArray parameter. If dataArray is not large enough to hold all the samples, the function returns an error and this parameter returns the minimum expected size of the output array. |
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 an niWLAN 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 niWLANA_GetErrorString function. The general meaning of the status code is as follows:
|
||||||||