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_ of the function name, use the prefix of the class driver with which you are working. For example, if you are working with the IviDmm class driver, use the prefix IviDmm_ to create the correct function name, IviDmm_error_query.

C Function Prototype

ViStatus ClassPrefix_error_query (ViSession vi, ViInt32 * errCode, ViChar errMessage[]);

Purpose

Queries the instrument and returns the instrument specific error information.

Generally, you call this function after another function in the instrument driver returns the IVI_ERROR_INSTRUMENT_STATUS error. The driver returns IVI_ERROR_INSTRUMENT_STATUS when the status register of the instrument indicates that the instrument's error queue is not empty. ClassPrefix_error_query 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.

Parameters

Inputs Type Description
vi ViSession The instrument handle that you obtain from the ClassPrefix_init or ClassPrefix_InitWithOptions functions. The handle identifies a particular IVI session.
     
Outputs Type Description
errCode ViInt32 Instrument error code
errMessage ViChar array Instrument error message. You must pass a ViChar array with at least 256 bytes.

Return Values

WAS THIS ARTICLE HELPFUL?

Not Helpful