RFmxSpecAn_IMFetchIntermodMeasurementArray
- Updated2025-04-08
- 2 minute(s) read
Fetches an array of peak powers of the lower and upper intermods.
Syntax
int32 __stdcall RFmxSpecAn_IMFetchIntermodMeasurementArray(niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, int32 intermodOrder[], float64 lowerIntermodAbsolutePower[], float64 upperIntermodAbsolutePower[], 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. |
selectorString | [in] | char | This parameter specifies a Selector String comprising of the signal name and result name. 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 "" (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. A value of -1 specifies that the function waits until the measurement is complete. The default value is 10. |
intermodOrder | [out] | int32 | This parameter returns an array of the orders of the intermods. |
lowerIntermodAbsolutePower | [out] | float64 | This parameter returns an array of the peak power values measured around the lower intermod frequency when you set the RFMXSPECAN_ATTR_IM_LOCAL_PEAK_SEARCH_ENABLED attribute to True. This value is expressed in dBm. When you set the IM Local Peak Search Enabled attribute to False, the measurement returns the power at the lower intermod frequency. |
upperIntermodAbsolutePower | [out] | float64 | This parameter returns an array of the peak power values measured around the upper intermod frequency when you set the IM Local Peak Search Enabled attribute to True. This value is expressed in dBm. When you set the IM Local Peak Search Enabled attribute to False, the measurement returns the power at the upper intermod frequency. |
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 RFmxSpecAn_GetError function.
The general meaning of the status code is as follows:
Value | Meaning |
---|---|
0 | Success |
Positive Values | Warnings |
Negative Values | Errors |