IviScope_AcquisitionStatus
IviScopeBase Capability Group
C Function Prototype
ViStatus IviScope_AcquisitionStatus (ViSession vi, ViInt32 *status);
Purpose
This function returns whether an acquisition is in progress, complete, or if the status is unknown.
Note This function returns in the status output parameter only the defined values that appear in the description of the status parameter in the Parameter table below. |
This function does not check the instrument status. Typically, You call this function only in a sequence of calls to other low-level driver functions. The sequence performs one operation. You use the low-level functions to optimize one or more aspects of interaction with the instrument. Call the IviScope_error_query function at the conclusion of the sequence to check the instrument status.
Parameters
Inputs | Type | Description |
---|---|---|
vi | ViSession | The instrument handle that you obtain from the IviScope_init or IviScope_InitWithOptions functions. The handle identifies a particular IVI session. |
Outputs | Type | Description |
status | ViInt32 | Acquisition complete.
Defined Values: IVISCOPE_VAL_ACQ_COMPLETE IVISCOPE_VAL_ACQ_IN_PROGRESS IVISCOPE_VAL_ACQ_STATUS_UNKNOWN |