Syntax

Top Previous Next


Boonton55xxx IVI Driver Reference

Btn55xxx_ReadPRF Function
Pulse See Also

Returns the number of cycles of a repetitive signal that take place in one second (Pulse Repetition Frequency).

Function Tree Node: \Boonton55xxx\Instrument Specific\Channel\Measurements\AutoMeasurements\Pulse\ReadPRF

Declaration: Btn55xxx.h

Implementation: Btn55xxx.dll

Visual C++

ViStatus Btn55xxx_ReadPRF(
ViSession Vi,
ViConstString Channel,
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.

IsValid

Measurement condition code.

Val

The number of cycles of a repetitive signal that take place in one second (Pulse Repetition Frequency).

Return Value

Success or failure code.

Requirements

Supported Models

All supported

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

Copyright 2013-16 Boonton. All rights reserved.