Configures the mechanical attenuation and the RFmx driver attenuation hardware settings.

Syntax

int32 __stdcall RFmxDemod_CfgMechanicalAttenuation(niRFmxInstrHandle instrumentHandle, char channelName[], int32 mechanicalAttenuationAuto, float64 mechanicalAttenuationValue)

Remarks

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

Parameters

NameDirectionTypeDescription
instrumentHandle[in]niRFmxInstrHandle

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

channelName[in]char[]

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

mechanicalAttenuationAuto[in]int32

Specifies whether the RFmx driver automatically chooses an attenuation setting based on the hardware settings.

Value

Description

RFMXDEMOD_VAL_MECHANICAL_ATTENUATION_AUTO_FALSE (0)

Specifies that the RFmx driver uses the value configured in the mechanicalAttenuationValue parameter.

RFMXDEMOD_VAL_MECHANICAL_ATTENUATION_AUTO_TRUE (1)

Specifies that the measurement computes the mechanical attenuation.

mechanicalAttenuationValue[in]float64

Specifies the level of mechanical attenuation, in dB, for the RF path when the mechanicalAttenuationAuto is set to RFMXDEMOD_VAL_MECHANICAL_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 RFmxDemod_GetError function.

The general meaning of the status code is as follows:

Value

Meaning

0

Success

Positive Values

Warnings

Negative Values

Errors