man2/timer_delete.2

   1 .\" Copyright (c) 2009 Linux Foundation, written by Michael Kerrisk
   2 .\"     <mtk.manpages@gmail.com>
   3 .\"
   4 .\" %%%LICENSE_START(verbatim)
   5 .\" Permission is granted to make and distribute verbatim copies of this
   6 .\" manual provided the copyright notice and this permission notice are
   7 .\" preserved on all copies.
   8 .\"
   9 .\" Permission is granted to copy and distribute modified versions of this
  10 .\" manual under the conditions for verbatim copying, provided that the
  11 .\" entire resulting derived work is distributed under the terms of a
  12 .\" permission notice identical to this one.
  13 .\"
  14 .\" Since the Linux kernel and libraries are constantly changing, this
  15 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  16 .\" responsibility for errors or omissions, or for damages resulting from
  17 .\" the use of the information contained herein.  The author(s) may not
  18 .\" have taken the same level of care in the production of this manual,
  19 .\" which is licensed free of charge, as they might when working
  20 .\" professionally.
  21 .\"
  22 .\" Formatted or processed versions of this manual, if unaccompanied by
  23 .\" the source, must acknowledge the copyright and authors of this work.
  24 .\" %%%LICENSE_END
  25 .TH TIMER_DELETE 2 2009-02-20 Linux "Linux Programmer's Manual"
  26 .SH NAME
  27 timer_delete \- delete a POSIX per-process timer
  28 .SH SYNOPSIS
  29 .nf
  30 .B  #include <time.h>
  31
  32 .BI "int timer_delete(timer_t " timerid );
  33 .fi
  34
  35 Link with \fI\-lrt\fP.
  36 .sp
  37 .in -4n
  38 Feature Test Macro Requirements for glibc (see
  39 .BR feature_test_macros (7)):
  40 .in
  41 .sp
  42 .BR timer_delete ():
  43 _POSIX_C_SOURCE\ >=\ 199309L
  44 .SH DESCRIPTION
  45 .BR timer_delete ()
  46 deletes the timer whose ID is given in
  47 .IR timerid .
  48 If the timer was armed at the time of this call,
  49 it is disarmed before being deleted.
  50 The treatment of any pending signal generated by the deleted timer
  51 is unspecified.
  52 .SH RETURN VALUE
  53 On success,
  54 .BR timer_delete ()
  55 returns 0.
  56 On failure, \-1 is returned, and
  57 .I errno
  58 is set to indicate the error.
  59 .SH ERRORS
  60 .TP
  61 .B EINVAL
  62 .I timerid
  63 is not a valid timer ID.
  64 .SH VERSIONS
  65 This system call is available since Linux 2.6.
  66 .SH CONFORMING TO
  67 POSIX.1-2001.
  68 .SH SEE ALSO
  69 .BR clock_gettime (2),
  70 .BR timer_create (2),
  71 .BR timer_getoverrun (2),
  72 .BR timer_settime (2),
  73 .BR time (7)