niTClk_WaitUntilDone
- Updated2023-02-21
- 1 minute(s) read
ViStatus niTClk_WaitUntilDone (ViUInt32 sessionCount, ViSession sessions [], ViReal64 timeout);
Purpose
Waits until the acquisitions and/or generations corresponding to the sessions are done, or until the function returns a timeout error.
niTClk_WaitUntilDone is a blocking function that periodically checks the operation status. This function returns control to the calling program, if the operation completes successfully, or if an error occurs (including a timeout error).
This function is most useful for finite data operations that you want to complete within a certain time.
Parameters
| Input |
| Name | Type | Description |
| sessionCount | ViUInt32 | Specifies the number of elements in the sessions array. |
| sessions | ViSession [] | Specifies the array of session references that are being synchronized. Obtain session references from the instrument driver by using the <driver name> Get Session Reference function, where <driver name> is the name of the instrument driver. Example: niScope_GetSessionReference. |
| timeout | ViReal64 | Specifies the amount of time, in seconds, that the niTClk_WaitUntilDone function waits, for the sessions to complete. If the timeout parameter is exceeded, the niTClk_WaitUntilDone function returns an error. |