Syntax

Top Previous Next


Boonton55xxx IVI Driver Reference

Btn55xxx_ReadMarkerAverage Function
MarkerMeasurements See Also

For the specified marker, return the average power or voltage at the marker. The units are the same as the specified channel.

Function Tree Node: \Boonton55xxx\Instrument Specific\Channel\MarkerMeasurements\Read Marker Average

Declaration: Btn55xxx.h

Implementation: Btn55xxx.dll

Visual C++

ViStatus Btn55xxx_ReadMarkerAverage(
ViSession Vi,
ViConstString Channel,
ViInt32 Marker,
ViInt32* IsValid,
ViReal32* Val
);

Parameters

Vi

The ViSession handle that you obtain from the IviDriver_init or IviDriver_InitWithOptions function. The handle identifies a particular instrument session.

Channel

The physical or virtual repeated capability identifier. Pass VI_NULL or empty string if operation does not apply to a repeated capability.For valid values, see the Channel repeated capability.

Marker

Marker number

IsValid

Condition code.

Val

Average power or voltage at the marker.

Return Value

Success or failure code.

Instrument Command

READ{Channel}:MARKer{1|2}:AVERAGE?

Requirements

Supported Models

All supported

Defined Values For Parameter Marker

Name	Description
BTN55XXX_VAL_MARKER_NUMBER_MARKER1	Marker 1
BTN55XXX_VAL_MARKER_NUMBER_MARKER2	Marker 2

Defined Values For Parameter IsValid

Name	Description
BTN55XXX_VAL_COND_CODE_MEASUREMENT_STOPPED	-1 Measurement is STOPPED. Value returned is not updated.
BTN55XXX_VAL_COND_CODE_ERROR	Error return. Measurement is not valid.
BTN55XXX_VAL_COND_CODE_UNDERRANGE	An Under-range condition exists.
BTN55XXX_VAL_COND_CODE_OVERRANGE	An Over-range condition exists.
BTN55XXX_VAL_COND_CODE_NORMAL	1 Normal return. No error.

See Also

Reference

MarkerMeasurements

Copyright 2013-16 Boonton. All rights reserved.