Configures an array of segment types.

Syntax

int32 __stdcall RFmxSpecAn_PAVTCfgSegmentTypeArray(niRFmxInstrHandle instrumentHandle, char selectorString[], int32 segmentType[], int32 numberOfElements)

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. If you do not specify the signal name, the default signal instance is used. The default value is "" (empty string).
Example:
""
"signal::sig1"
You can use the RFmxSpecAn_BuildSignalString function to build the selector string.

segmentType[in]int32

This parameter specifies the type of segment. The default value is Phase and Amplitude.

Name

Value

Description

RFMXSPECAN_VAL_PAVT_SEGMENT_TYPE_PHASE_AND_AMPLITUDE

0 (0x0)

Phase and amplitude is measured in this segment.

RFMXSPECAN_VAL_PAVT_SEGMENT_TYPE_AMPLITUDE

1 (0x1)

Amplitude is measured in this segment.

RFMXSPECAN_VAL_PAVT_SEGMENT_TYPE_FREQUENCY_ERROR_MEASUREMENT

2 (0x2)

Frequency error is measured in this segment.

numberOfElements[in]int32

Specifies the number of elements in each array.

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