List |
public bool TryWaitForListDone( out int? listID, int? timeout = null )
| null (or omitted) | use the default timeout period specified by ClientAPITimeout |
| -1 | wait indefinitely for the event |
| 0 | do not wait, simply check if an event has already been reported |
| > 0 | timeout period in ms |
| true | if an event is reported within the specified timeout period, |
| false | otherwise. |
| Exception | Condition |
|---|---|
| ThreadInterruptedException | The wait was interrupted prematurely. |
| ListExecutionException | see12.7 Exceptions and Errors |
| ExecutionException | see12.7 Exceptions and Errors |
| FatalException | see12.7 Exceptions and Errors |
| AbortedException | see12.7 Exceptions and Errors |
| OutOfFieldException | see12.7 Exceptions and Errors |
Note that in case of a timeout this function will always return false.
See WaitForListDone(NullableInt32, NullableInt32) if you wish to wait for a TimeoutException instead.
Waiting can be interrupted by calling InterruptWaitForListDone.
Doing so will cause a ThreadInterruptedException.