Configures the nominal attenuation and the RFmx driver setting.

Syntax

int32 __stdcall RFmxBT_CfgRfAttenuation(niRFmxInstrHandle instrumentHandle, char channelName[], int32 rfAttenuationAuto, float64 rfAttenuationValue)

Remarks

This function is a wrapper over the RFmx Instruments API, and calls the RFmxInstr_CfgRFAttenuation function.

Parameters

NameDirectionTypeDescription
instrumentHandle[in]niRFmxInstrHandle

Identifies the RFmx session. You can obtain this parameter from the RFmxBT_Initialize function.

channelName[in]char

Set this parameter to "" (empty string) or NULL.

rfAttenuationAuto[in]int32

Specifies whether the RFmx driver computes the RF attenuation.

Value

Description

RFMXBT_VAL_RF_ATTENUATION_AUTO_FALSE (0)

Specifies that the RFmx driver uses the value configured using the rfAttenuationValue parameter.

RFMXBT_VAL_RF_ATTENUATION_AUTO_TRUE (1)

Specifies that the RFmx driver computes the RF attenuation automatically.

rfAttenuationValue[in]float64

Specifies the nominal attenuation setting, in dB, for all attenuators before the first mixer in the RF signal chain when the rfAttenuationAuto parameter is set to RFMXBT_VAL_RF_ATTENUATION_AUTO_FALSE.

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