QueryInstrStatus

IVI Library

Ivi_QueryInstrStatus

Usage

ViBoolean = Ivi_QueryInstrStatus(ViSession vi);

Purpose

This function returns the current value of the IVI_ATTR_QUERY_INSTRUMENT_STATUS attribute for the session you specify.

Use Ivi_QueryInstrStatus in the high-level functions in specific instrument drivers. Ivi_QueryInstrStatus provides fast, convenient access to the IVI_ATTR_QUERY_INSTRUMENT_STATUS attribute because it does no error checking and does not lock the session.

Note  Do not call this function unless you have already locked the session.

Parameters

Name Type Description
vi ViSession

The ViSession handle that you obtain from Ivi_SpecificDriverNew. The handle identifies a particular IVI session.

Return Value

Returns the value of the IVI_ATTR_QUERY_INSTRUMENT_STATUS attribute for the session. This attribute determines whether or not to query the instrument error status after each operation.

Values:

VI_TRUE (1) Query instrument status
VI_FALSE (0) Do not query instrument status

If you pass an invalid session handle to the function, this parameter returns VI_FALSE.

Related Topic

IVI Status Codes