Prefix_revision_query

IVI Library

Prefix_revision_query

ViStatus Prefix_revision_query (ViSession vi, ViChar driverRev[], ViChar instrRev[]);

Purpose

Obtains the following information:

  • The revision of the instrument driver
  • The firmware revision of the instrument you are currently using

Parameter

Input
Name Type Description
vi ViSession Unique logical identifier to a session with an instrument
Output
Name Type Description
driverRev ViChar array Instrument driver revision
instrRev ViChar array Instrument firmware revision

Return Values

Contains the status code that the function call returns. IVI engine functions can return error and warning values from several sets of status codes. Some status codes are unique to the IVI engine. Other status codes are the same codes that VISA Library functions return. Still others are error or warning values that functions in specific instrument drivers return. Each set of status codes has its own numeric range.

Regardless of the source of the status code, 0 always indicates success, a positive value indicates a warning, and a negative value indicates an error.

Related Topic

IVI Status Codes

Implementation Requirements

Report an error if the user passes VI_NULL for either of the output parameters.

Call Ivi_LockSession to lock the IVI session.

Call Ivi_GetAttributeViString on the IVI_ATTR_DRIVER_REVISION attribute to get the driver revision string into the driverRev output parameter.

If simulation is disabled, send the revision query command to the instrument. On IEEE 488.2 instruments, you do this by sending the *IDN command. Then read the results from the instrument into instrRev output parameter. Remember to call Ivi_SetNeedToCheckStatus with VI_TRUE before you perform the instrument I/O.

If simulation is enabled, copy "No revision information available while simulating." into the instrRev output parameter.

Call your internal Prefix_CheckStatus function.

Call Ivi_UnlockSession to unlock the IVI session.