RFmxInstr_CheckAcquisitionStatus
- Updated2025-10-13
- 1 minute(s) read
Checks the status of the acquisition. Use this function to check for any errors that may occur during acquisition, or to check whether RFmx has completed the acquisition operation.
Syntax
int32 __stdcall RFmxInstr_CheckAcquisitionStatus(niRFmxInstrHandle instrumentHandle, int32 *acquisitionDone)
Parameters
| Name | Direction | Type | Description |
|---|---|---|---|
| instrumentHandle | [in] | niRFmxInstrHandle | This parameter identifies the instrument session. This parameter is obtained from the RFmxInstr_Initialize function or the RFmxInstr_InitializeFromNIRFSASessionArray function. |
| acquisitionDone | [out] | int32 * | This parameter indicates whether the acquisition is complete. The default value is FALSE. |
Returns
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 RFmx 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 RFmxInstr_GetError function.
The general meaning of the status code is as follows:
Value | Meaning |
|---|---|
0 | Success |
Positive Values | Warnings |
Negative Values | Errors |