RFmx LTE CVI

Content Type
Programming Language
Current manual

RFmxLTE_CfgMechanicalAttenuation

RFmxLTE_CfgMechanicalAttenuation

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

Purpose

Configures the mechanical attenuation and the RFmx attenuation hardware settings.

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

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx obtains this parameter from the RFmxLTE_Initialize function.
channelName char[] Set this parameter to "" (empty string) or NULL.
mechanicalAttenuationAuto int32 Specifies whether the RFmx chooses an attenuation setting based on the hardware settings.
RFMXLTE_VAL_MECHANICAL_ATTENUATION_AUTO_FALSE(0)

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

RFMXLTE_VAL_MECHANICAL_ATTENUATION_AUTO_TRUE(1)

Specifies that the measurement computes the mechanical attenuation.

mechanicalAttenuationValue float64 Specifies the level of mechanical attenuation for the RF path. This value is expressed in dB.

Return Value

Name Type Description
status int32 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 RFmxLTE_GetError function.

The general meaning of the status code is as follows:

Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors
Was this information helpful?