clear_timed_event

clear_timed_event — Clear the specified timed event

#include "scheduler.h"

| void **clear_timed_event** ( | evt); |   |

Event * <var class="pdparam">evt</var>;

Clear the specified timed event.

You cancel timed events using this function, which will implicitly free the event if it was found in the system. Otherwise it will return 0 and the caller is responsible for freeing the event.

Parameters

Return Values

On success this function returns 1. When 0 is returned, the caller is responsible for freeing the event.

Threading

Only call this function from the Scheduler thread.

“Event” and “The Event API”