Syntax

Top Previous Next


Boonton55xxx IVI Driver Reference

Btn55xxx_GetUnits Function
Channel See Also

Set or return units for the selected channel. Voltage is calculated with reference to the sensor input impedance. Note that for ratiometric results, logarithmic units will always return dBr (dB relative) while linear units return percent.

Function Tree Node: \Boonton55xxx\Instrument Specific\Channel\Get Units

Declaration: Btn55xxx.h

Implementation: Btn55xxx.dll

Visual C++

ViStatus Btn55xxx_GetUnits(
ViSession Vi,
ViConstString Channel,
ViInt32* Units
);

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.

Units

Set or return units for the selected channel. Voltage is calculated with reference to the sensor input impedance. Note that for ratiometric results, logarithmic units will always return dBr (dB relative) while linear units return percent.

Return Value

Success or failure code.

Instrument Command

CALCulate{Channel}:UNITs?

Requirements

Supported Models

All supported

Defined Values For Parameter Units

Name	Description
BTN55XXX_VAL_UNITSD_BM	dBm
BTN55XXX_VAL_UNITSWATTS	Watts.
BTN55XXX_VAL_UNITSVOLTS	Volts.
BTN55XXX_VAL_UNITSDBV	dB relative to volts.
BTN55XXX_VAL_UNITSDBMV	dB relative to milliwatts.
BTN55XXX_VAL_UNITSDBUV	dB relative to microwatts.

See Also

Reference

Copyright 2013-16 Boonton. All rights reserved.