lib/libc/sys/timer_delete.2

   1 .\" Copyright (c) 2005 David Xu <davidxu@FreeBSD.org>
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice(s), this list of conditions and the following disclaimer as
   9 .\"    the first lines of this file unmodified other than the possible
  10 .\"    addition of one or more copyright notices.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice(s), this list of conditions and the following disclaimer in
  13 .\"    the documentation and/or other materials provided with the
  14 .\"    distribution.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) ``AS IS'' AND ANY
  17 .\" EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  19 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT HOLDER(S) BE
  20 .\" LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  21 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  22 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
  23 .\" BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  24 .\" WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
  25 .\" OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
  26 .\" EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27 .\"
  28 .\" $FreeBSD$
  29 .\"
  30 .Dd September 11, 2000
  31 .Dt TIMER_DELETE 2
  32 .Os
  33 .Sh NAME
  34 .Nm timer_delete
  35 .Nd "delete a per-process timer (REALTIME)"
  36 .Sh LIBRARY
  37 .Lb librt
  38 .Sh SYNOPSIS
  39 .In time.h
  40 .Ft int
  41 .Fn timer_delete "timer_t timerid"
  42 .Sh DESCRIPTION
  43 The
  44 .Fn timer_delete
  45 system call
  46 deletes the specified timer,
  47 .Fa timerid ,
  48 previously created by the
  49 .Xr timer_create 2
  50 system call.
  51 If the timer is armed when
  52 .Fn timer_delete
  53 is called, the behavior is as if the timer is automatically disarmed before
  54 removal.
  55 Pending signals for the deleted timer are cleared.
  56 .Sh RETURN VALUES
  57 .Rv -std
  58 .Sh ERRORS
  59 The
  60 .Fn timer_delete
  61 system call
  62 will fail if:
  63 .Bl -tag -width Er
  64 .It Bq Er EINVAL
  65 The timer ID specified by
  66 .Fa timerid
  67 is not a valid timer ID.
  68 .El
  69 .Sh SEE ALSO
  70 .Xr timer_create 2
  71 .Sh STANDARDS
  72 The
  73 .Fn timer_delete
  74 system call conforms to
  75 .St -p1003.1-2004 .
  76 .Sh HISTORY
  77 Support for
  78 .Tn POSIX
  79 per-process timer first appeared in
  80 .Fx 7.0 .