RFmxInstr_WaitForAcquisitionComplete
- Updated2025-04-08
- 1 minute(s) read
Waits and blocks the data flow until the acquisition is complete. This function is typically called after a specific initiate function.
Syntax
int32 __stdcall RFmxInstr_WaitForAcquisitionComplete(niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout)
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. |
| selectorString | [in] | char | Specifies a selector string. Pass an empty string. |
| timeout | [in] | float64 | This parameter specifies the time to wait for an ongoing acquisition to complete before returning a timeout error. A value of -1 specifies that the function waits indefinitely for acquisition to complete. This value is expressed in seconds. The default value is 10. |
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 |