timer_delete - Man Page

delete a per-process timer

Prolog

This manual page is part of the POSIX Programmer's Manual. The Linux implementation of this interface may differ (consult the corresponding Linux manual page for details of Linux behavior), or the interface may not be implemented on Linux.

Synopsis

#include <time.h>

int timer_delete(timer_t timerid);

Description

The timer_delete() function deletes the specified timer, timerid, previously created by the timer_create() function. If the timer is armed when timer_delete() is called, the behavior shall be as if the timer is automatically disarmed before removal. The disposition of pending signals for the deleted timer is unspecified.

The behavior is undefined if the value specified by the timerid argument to timer_delete() does not correspond to a timer ID returned by timer_create() but not yet deleted by timer_delete().

Return Value

If successful, the timer_delete() function shall return a value of zero. Otherwise, the function shall return a value of -1 and set errno to indicate the error.

Errors

No errors are defined.

The following sections are informative.

Examples

None.

Application Usage

None.

Rationale

If an implementation detects that the value specified by the timerid argument to timer_delete() does not correspond to a timer ID returned by timer_create() but not yet deleted by timer_delete(), it is recommended that the function should fail and report an [EINVAL] error.

Future Directions

None.

See Also

timer_create()

The Base Definitions volume of POSIX.1-2017, <time.h>

Referenced By

time.h(0p), timer_create(3p).

2017 IEEE/The Open Group POSIX Programmer's Manual