RFmxWLAN_OFDMModAccFetchUserStreamPilotRMSEVMPerSymbolMeanTrace
- Updated2025-04-08
- 2 minute(s) read
Fetches the stream pilot-subcarriers RMS EVM per symbol trace for each user.
Use "user<n>/stream<k>" as the selector string to read results from this function.
Syntax
int32 __stdcall RFmxWLAN_OFDMModAccFetchUserStreamPilotRMSEVMPerSymbolMeanTrace(niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float64 *x0, float64 *dx, float32 userStreamPilotRMSEVMPerSymbolMean[], int32 arraySize, int32 *actualArraySize)
Parameters
| Name | Direction | Type | Description |
|---|---|---|---|
| instrumentHandle | [in] | niRFmxInstrHandle | This parameter specifies the RFmx session refnum. Instrument Handle In is obtained from the RFmxInstr_Initialize function or the RFmxInstr_InitializeFromNIRFSASessionArray function. |
| selectorString | [in] | char | This parameter specifies a Selector String comprising of the signal name, result name, user number, and stream number. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used. The default value is "user0/stream0". |
| timeout | [in] | float64 | This parameter specifies the timeout for fetching the specified measurement. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the function waits until the measurement is complete. This value is expressed in seconds. The default value is 10. |
| x0 | [out] | float64 * | This parameter returns the starting OFDM symbol index corresponding to the value of RFMXWLAN_ATTR_OFDMMODACC_MEASUREMENT_OFFSET attribute. |
| dx | [out] | float64 * | This parameter returns the OFDM symbol increment value. This value is always equal to 1. |
| userStreamPilotRMSEVMPerSymbolMean | [out] | float32 | This parameter returns the stream pilot-subcarriers RMS EVM per symbol trace for each user. When you set the Averaging Enabled attribute to True, this parameter returns the mean of the user stream pilot RMS EVM per symbol computed for each averaging count. |
| arraySize | [in] | int32 | Specifies the size of the array. Set the arraySize parameter to 0 to get the size of all the arrays in the actualArraySize parameter. |
| actualArraySize | [out] | int32 * | Returns the actual size of the array, if you pass NULL to all output array parameters, and set the arraySize parameter to 0. |
Returns
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 RFmx 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 RFmxWLAN_GetError function.
The general meaning of the status code is as follows:
Value | Meaning |
|---|---|
0 | Success |
Positive Values | Warnings |
Negative Values | Errors |