NI-RFSA C Function Reference

niRFSA_CheckAcquisitionStatus

  • Updated2025-05-22
  • 1 minute(s) read

niRFSA_CheckAcquisitionStatus

ViStatus niRFSA_CheckAcquisitionStatus(ViSession vi, ViBoolean* isDone);

Purpose

Checks the status of the acquisition. Use this function to check for any errors that may occur during signal acquisition or to check whether the device has completed the acquisition operation.

Supported Devices: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5694/5698, PXIe-5820/5830/5831/5832/5840/5841/5842/5860

Related Topics

NI RF Vector Signal Analyzer State Diagram

Parameters

Input
Name Type Description
vi ViSession Identifies your instrument session. vi is obtained from the niRFSA_init or niRFSA_InitWithOptions function.
Output
Name Type Description
isDone ViBoolean* Returns signal acquisition status.

VI_TRUESignal acquisition is complete.
VI_FALSESignal acquisition is not complete.

Return Value

Name Type Description
status ViStatus Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an NI-RFSA function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the niRFSA_GetError function. To clear the error information from NI-RFSA, call the niRFSA_ClearError function.

The general meaning of the status code is as follows:

Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

Log in to get a better experience