collapse_allSyntax

Top  Previous  Next

 

Boonton55xxx IVI Driver Reference


 

Btn55xxx_FetchArrayMarkerPower Function


MarkerMeasurements See Also



Returns an array of the current marker measurements for the specified channel.

Function Tree Node: \Boonton55xxx\Instrument Specific\Channel\MarkerMeasurements\Fetch Array Marker Power

Declaration: Btn55xxx.h

Implementation: Btn55xxx.dll

Visual C++

ViStatus Btn55xxx_FetchArrayMarkerPower(
 ViSession Vi,
 ViConstString Channel,
 ViReal32AvgPower,
 ViInt32AvgPowerCondCode,
 ViReal32MaxPower,
 ViInt32MaxPowerCondCode,
 ViReal32MinPower,
 ViInt32MinPowerCondCode,
 ViReal32PkToAvgRatio,
 ViInt32PkToAvgRatioCondCode,
 ViReal32Marker1Power,
 ViInt32Marker1PowerCondCode,
 ViReal32Marker2Power,
 ViInt32Marker2PowerCondCode,
 ViReal32MarkerRatio,
 ViInt32MarkerRatioCondCode
);

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.

AvgPower

Average power between the markers.

AvgPowerCondCode

Condition code.

MaxPower

Maximun power between the markers.

MaxPowerCondCode

Condition code.

MinPower

minimum power between the markers.

MinPowerCondCode

Condition code.

PkToAvgRatio

The ratio of peak to average power between the markers.

PkToAvgRatioCondCode

Condition code.

Marker1Power

The power at Marker 1.

Marker1PowerCondCode

Condition code.

Marker2Power

The power at Marker 2.

Marker2PowerCondCode

Condition code.

MarkerRatio

Ratio of power at Marker 1 and power at Marker 2.

MarkerRatioCondCode

Condition code.

Return Value

 

Success or failure code.

collapse_allRequirements

Supported Models

All supported

collapse_allDefined Values For Parameter AvgPowerCondCode

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.

Top

collapse_allDefined Values For Parameter MaxPowerCondCode

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.

Top

collapse_allDefined Values For Parameter MinPowerCondCode

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.

Top

collapse_allDefined Values For Parameter PkToAvgRatioCondCode

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.

Top

collapse_allDefined Values For Parameter Marker1PowerCondCode

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.

Top

collapse_allDefined Values For Parameter Marker2PowerCondCode

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.

Top

collapse_allDefined Values For Parameter MarkerRatioCondCode

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.

Top

collapse_allSee Also

Reference

MarkerMeasurements

Btn55xxx

Footer image

Copyright 2013-16 Boonton. All rights reserved.