collapse_allSyntax

Top  Previous  Next

 

Boonton55xxx IVI Driver Reference


 

Btn55xxx_FetchIntervalPkToAvg Function


Interval See Also



Return the peak-to-average ratio of the power or voltage between marker 1 and marker 2. The units are dB for logarithmic channel units or percent for linear channel units.

Function Tree Node: \Boonton55xxx\Instrument Specific\Channel\MarkerMeasurements\Interval\Fetch Interval Pk To Avg

Declaration: Btn55xxx.h

Implementation: Btn55xxx.dll

Visual C++

ViStatus Btn55xxx_FetchIntervalPkToAvg(
 ViSession Vi,
 ViConstString Channel,
 ViInt32ConditionCode,
 ViReal32Val
);

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.

ConditionCode

Condition Code

Val

Peak-to-average ratio of the power or voltage between marker 1 and marker 2.

Return Value

 

Success or failure code.

collapse_allRequirements

Supported Models

All supported

collapse_allDefined Values For Parameter ConditionCode

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

Interval

Btn55xxx

Footer image

Copyright 2013-16 Boonton. All rights reserved.