RFmxPulse_WaitForAcquisitionComplete
- Updated2025-04-08
- 1 minute(s) read
Waits and blocks the data flow until the acquisition is done. This function is typically called after the specific Initiate function.
Syntax
int32 __stdcall RFmxPulse_WaitForAcquisitionComplete(niRFmxInstrHandle instrumentHandle, float64 timeout)
Remarks
This function is a wrapper over the RFmx Instruments API, and calls the RFmxInstr_WaitForAcquisitionComplete function.
Parameters
Name | Direction | Type | Description |
---|---|---|---|
instrumentHandle | [in] | niRFmxInstrHandle | Identifies the RFmx session. You can obtain this parameter from the RFmxPulse_Initialize function. |
timeout | [in] | float64 | Specifies the timeout, in seconds, for fetching the specified measurement. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the function waits until the measurement is complete. |
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 RFmxPulse_GetError function.
The general meaning of the status code is as follows:
Value | Meaning |
---|---|
0 | Success |
Positive Values | Warnings |
Negative Values | Errors |