ClassPrefix Error-Query

IVI Driver Help

Edition Date: August 2011

Part Number: 370430H-01

»View Product Info
Download Help (Windows Only)

IVI Inherent Function

To form the ClassPrefix VI name, use the prefix of the class driver that you are working with. For example, if you are working with the IviDmm class driver, use the prefix IviDmm to create the correct VI name, IviDmm Error-Query.

This VI queries the instrument and returns the instrument specific error information.

Generally, you call this VI after another VI in the instrument driver returns the IVI_ERROR_INSTRUMENT_STATUS (0xBFFA0001) error code. The driver returns this error code when the instrument's status register indicates that the instrument's error queue is not empty. The ClassPrefix Error Query VI extracts the first error out of the instrument's error queue. For instruments that have status registers but no error queue, the driver simulates an error queue in software.

instrument handle The instrument handle that you obtain from the ClassPrefix Initialize or ClassPrefix Initialize With Options VI. The handle identifies a particular instrument session.
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.

instrument handle out The instrument handle that you obtain from the ClassPrefix Initialize or ClassPrefix Initialize With Options VI. The handle identifies a particular instrument session.
error code Returns the error code read from the instrument's error queue.
error message Returns the error message string read from the instrument's error message queue.
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.

WAS THIS ARTICLE HELPFUL?

Not Helpful