Specifies the criteria to determine the measurement fail status. Use "offset<n>" as the selector string to configure this function.

Syntax

int32 __stdcall RFmxSpecAn_SEMCfgOffsetLimitFailMask(niRFmxInstrHandle instrumentHandle, char selectorString[], int32 limitFailMask)

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

limitFailMask[in]int32

This parameter specifies the criteria to determine the measurement fail status. The default value is Absolute.

Name

Value

Description

RFMXSPECAN_VAL_SEM_OFFSET_LIMIT_FAIL_MASK_ABSOLUTE_AND_RELATIVE

0 (0x0)

The measurement fails if the power in the segment exceeds both the absolute and relative masks.

RFMXSPECAN_VAL_SEM_OFFSET_LIMIT_FAIL_MASK_ABSOLUTE_OR_RELATIVE

1 (0x1)

The measurement fails if the power in the segment exceeds either the absolute or relative mask.

RFMXSPECAN_VAL_SEM_OFFSET_LIMIT_FAIL_MASK_ABSOLUTE

2 (0x2)

The measurement fails if the power in the segment exceeds the absolute mask.

RFMXSPECAN_VAL_SEM_OFFSET_LIMIT_FAIL_MASK_RELATIVE

3 (0x3)

The measurement fails if the power in the segment exceeds the relative mask.

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