DiscardAsyncTimer
int DiscardAsyncTimer (int timerID);
Purpose
This function discards the asynchronous timer with the specified timer ID. The function removes the timer from the list of existing timers and stops the timer events from occurring. The timer, thus, ceases to exist.
If the ID is specified as –1, all timers are discarded.
 |
Note A call to create or discard an asynchronous timer will not complete (will block) until all outstanding asynchronous callbacks return. |
Parameters
Input |
Name |
Type |
Description |
timerID |
integer |
Specifies the timer ID of the timer to be discarded. If specified as –1, all timers are discarded. |
Return Value
Name |
Type |
Description |
status |
integer |
Return value indicating whether the function was successful. A negative number indicates that an error occurred.
Return Values: |
0 | Success. |
–1 | The system failed to allocate a timer. |
–2 | No more IDs are available to assign to a new timer. |
–3 | Not enough memory left for this operation. |
–4 | The timer with the given ID was not found. |
–5 | Initialization with a call to NewAsyncTimer was not done. |
–6 | An internal error occurred. |
–7 | The value of a parameter passed to this function was invalid. |
|