clear_timed_event

March 26, 2020 Contributors

Name

clear_timed_event — Clear the specified timed event

Synopsis

#include "scheduler.h"

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

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

Description

Clear the specified timed event.

Note

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

e

The Event that you wish to close.

Return Values

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

Threading

Warning

Only call this function from the Scheduler thread.

See Also

“Event” and “The Event API”