EVENTSET: eventset_delete() - delete an event from an EVENTSET

Name

eventset_delete()

Synopsis

#include "eventset.h"
err_t eventset_delete(EVENTSET *evs, ACTIVE_JOB *acp)

Description

The eventset_delete() function deletes an ACTIVE_JOB (and hence its event) from an EVENTSET. The event must previously have been added to the EVENTSET via the function eventset_insert(). The ACTIVE_JOB parameter must be the same one that was used in the corresponding eventset_insert().

It is not always necessary to call eventset_delete(), as there are other ways that an ACTIVE_JOB's life could end. For example, the handler could return non-zero, or evenset_stop(), could be called.

Return value

eventset_delete() returns NULL if successful, or non-NULL otherwise. If non-NULL, the err_t object contains error strings which may be printed or otherwise communicated to the user.

See also

eventset_insert()
eventset_stop()