RFmxBT_ACPFetchOffsetMeasurementArray
- Updated2025-04-08
- 3 minute(s) read
Fetches the array of absolute powers, relative powers and margins measured in the offset channels.
Syntax
int32 __stdcall RFmxBT_ACPFetchOffsetMeasurementArray(niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float64 lowerAbsolutePower[], float64 upperAbsolutePower[], float64 lowerRelativePower[], float64 upperRelativePower[], float64 lowerMargin[], float64 upperMargin[], int32 arraySize, int32 *actualArraySize)
Parameters
| Name | Direction | Type | Description |
|---|---|---|---|
| instrumentHandle | [in] | niRFmxInstrHandle | This parameter specifies the RFmx session refnum. This parameter is obtained from the RFmxInstr_Initialize function. |
| selectorString | [in] | char | This parameter specifies a Selector String comprising of the signal name and the 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 for fetching the specified measurement. This value is expressed in seconds. 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. |
| lowerAbsolutePower | [out] | float64 | This parameter returns the array of absolute power measured in the lower offset channel. This value is expressed in dBm. |
| upperAbsolutePower | [out] | float64 | This parameter returns the array of absolute power measured in the upper offset channel. This value is expressed in dBm. |
| lowerRelativePower | [out] | float64 | This parameter returns the array of relative power in the lower offset channel measured with respect to the reference channel power. This value is expressed in dB. |
| upperRelativePower | [out] | float64 | This parameter returns array of the relative power in the upper offset channel measured with respect to the reference channel power. This value is expressed in dB. |
| lowerMargin | [out] | float64 | This parameter returns the array of margin from the limit specified by the mask with Exception for lower offset channel. This value is expressed in dB. Margin is defined as the difference between the Offset Absolute Power and Mask with Exception. This parameter is valid only if you set the RFMXBT_ATTR_ACP_OFFSET_CHANNEL_MODE attribute to In-band. This parameter returns NaN if you set the ACP Offset Channel Mode attribute to Symmetric. |
| upperMargin | [out] | float64 | This parameter returns the array of the margin from the limit specified by the mask with Exception for upper offset channel. This value is expressed in dB. Margin is defined as the difference between the offset absolute power and mask with exception. This parameter is valid only if you set the ACP Offset Channel Mode attribute to In-band. This parameter returns NaN if you set the ACP Offset Channel Mode attribute to Symmetric. |
| 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 RFmxBT_GetError function.
The general meaning of the status code is as follows:
Value | Meaning |
|---|---|
0 | Success |
Positive Values | Warnings |
Negative Values | Errors |