RFmxWCDMA_WaitForAcquisitionComplete
- Updated2024-10-14
- 1 minute(s) read
RFmxWCDMA_WaitForAcquisitionComplete
int32 __stdcall RFmxWCDMA_WaitForAcquisitionComplete (niRFmxInstrHandle instrumentHandle, float64 timeout);
Purpose
Waits and blocks the data flow until the acquisition is complete. This function is typically called after a specific initiate function.
This function is a wrapper over the RFmx Instruments API, and calls the RFmxInstr_WaitForAcquisitionComplete function.
Parameters
| Input | ||
| Name | Type | Description |
| instrumentHandle | niRFmxInstrHandle | Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxWCDMA_Initialize function. |
| timeout | 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. |
Return Value
| Name | Type | Description | ||||||||
| status | int32 | 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 RFmxWCDMA_GetError function. The general meaning of the status code is as follows:
|
||||||||