Admin Production ni-theme
Current Publication

Read

IVI Compliance Package

IviCounter Read

IviCounterBase Capability Group

Initiates and fetches a measurement based on the preset configuration.

Note Note  You must configure measurement type and inputs before calling this VI.

IviCounter Read.vi

civrn instrument handle The instrument handle that you obtain from the IviCounter Initialize VI or IviCounter Initialize With Options VI. The handle identifies a particular instrument session.

Default Value: None
ci32 maximum time (5000 ms) Pass the maximum length of time in which to allow the read operation to complete. Express this value in milliseconds.

If the operation does not complete within this time interval, the VI returns the IVICOUNTER_ERROR_MAX_TIME_EXCEEDED (0xBFFA2003) error code. When this occurs, you can call IviCounter Abort to cancel the read operation and return the instrument to the Idle state.

Defined Values:

IVICOUNTER_VAL_MAX_TIME_INFINITE (-1) - Wait indefinitely for a timeout.
IVICOUNTER_VAL_MAX_TIME_IMMEDIATE (0) - Do not wait for a timeout.

Default Value: 5000 (ms)
Note Note  The maximum time input affects only this VI. It has no effect on other timeout parameters or properties.
cerrcodeclst error in (no error) The error in cluster can accept error information wired from VIs previously called. Use this information to decide if any functionality should be bypassed in the event of errors from other VIs.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.
iivrn instrument handle out The instrument handle that you obtain from the IviCounter Initialize VI or IviCounter Initialize With Options VI. The handle identifies a particular instrument session.

Default Value: None
idbl measurement Returns the measured value.

The units depend on the Measurement Function you select as shown below.

Rise Time seconds
Fall Time seconds
Frequency hertz
Frequency Ratiounits
PRF hertz
Period seconds
Phase degrees
Negative seconds
Width Positive seconds
Cycle Negative percent
Duty Cycle Positive percent
Time Interval seconds
Totalize occurrences
ierrcodeclst error out The error out cluster passes error or warning information out of a VI to be used by other VIs.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.