Configures whether to consider the carrier power as part of total carrier power measurement. Use "carrier<n>" as the selector string to configure this function.

Syntax

int32 __stdcall RFmxSpecAn_SEMCfgCarrierEnabled(niRFmxInstrHandle instrumentHandle, char selectorString[], int32 carrierEnabled)

Parameters

NameDirectionTypeDescription
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 carrier number. If you do not specify the signal name, the default signal instance is used.
Example:
"carrier0"
"signal::sig1/carrier0"
You can use the RFmxSpecAn_BuildCarrierString2 function to build the selector string.

carrierEnabled[in]int32

This parameter specifies whether to consider the carrier power as part of total carrier power measurement. The default value is True.

Name

Value

Description

RFMXSPECAN_VAL_SEM_ENABLED_FALSE

0 (0x0)

The carrier power is not considered as part of the total carrier power.

RFMXSPECAN_VAL_SEM_ENABLED_TRUE

1 (0x1)

The carrier power is considered as part of the total carrier power.

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