RFmxSpecAn_HarmRead
- Updated2025-04-08
- 2 minute(s) read
Configures hardware for acquisition, performs measurement on acquired data, and returns Harmonics measurement results.
Syntax
int32 __stdcall RFmxSpecAn_HarmRead(niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float64 *totalHarmonicDistortion, float64 *averageFundamentalPower)
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. |
| selectorString | [in] | char | This parameter specifies a Selector String comprising of the signal name. If you do not specify the signal name, the default signal instance is used. The default value is "" (empty string). |
| timeout | [in] | float64 | This parameter specifies the timeout, in seconds, for fetching the specified measurement. Set this value to an appropriate time, longer than expected for fetching the measurement. The default value is 10. |
| totalHarmonicDistortion | [out] | float64 * | This parameter returns the total harmonics distortion (THD), measured as a percentage of the power in the fundamental signal. THD calculation involves only the harmonics that are enabled. |
| averageFundamentalPower | [out] | float64 * | This parameter returns the average power, in dBm, measured at the fundamental frequency. |
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 RFmxSpecAn_GetError function.
The general meaning of the status code is as follows:
Value | Meaning |
|---|---|
0 | Success |
Positive Values | Warnings |
Negative Values | Errors |