appCORE - coreTimerCancel()

NAME

coreTimerCancel() -- cancel a timer.

SYNOPSIS

include "appcore.h"

int coreTimerCancel( corehTIMER_t h )

DESCRIPTION

The coreTimerCancel() function cancels an existing timer. The timer may only be canceled once. A timer may be canceled at any time prior to expiration, even if the expiration message is waiting to be processed in the thread's input queue. Because the expiration handler is called in the context of the original thread, the timer may be "in transit" and still able to be canceled. The timer cancellation function updates the timer's state to canceled. The timer's state defines its expiration behavior. Canceled timers are reclaimed by the system.

PARAMETERS

h
	Timer handle.

RETURN VALUE

If successful, coreTimerCancel() returns 0. On failure it returns a value of -1 and sets errno to one of the following values.

errno Value	Condition
ENOTSUP	The timer feature is disabled.
EINVAL	The timer handle is invalid.
EIDRM	The timer handle is stale.

MULTI-THREAD SAFETY LEVEL

MT-safe.