lib/libc/sys/timer_delete.2

   1 .\"     $NetBSD: timer_delete.2,v 1.5 2008/04/30 13:10:51 martin Exp $
   2 .\"
   3 .\" Copyright (c) 2003 The NetBSD Foundation, Inc.
   4 .\" All rights reserved.
   5 .\"
   6 .\" This code is derived from software contributed to The NetBSD Foundation
   7 .\" by Christos Zoulas.
   8 .\"
   9 .\" Redistribution and use in source and binary forms, with or without
  10 .\" modification, are permitted provided that the following conditions
  11 .\" are met:
  12 .\" 1. Redistributions of source code must retain the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer.
  14 .\" 2. Redistributions in binary form must reproduce the above copyright
  15 .\"    notice, this list of conditions and the following disclaimer in the
  16 .\"    documentation and/or other materials provided with the distribution.
  17 .\"
  18 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  19 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  20 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  21 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
  22 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  23 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  24 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  25 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  26 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  27 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  28 .\" POSSIBILITY OF SUCH DAMAGE.
  29 .\"
  30 .Dd September 13, 2003
  31 .Dt TIMER_DELETE 2
  32 .Os
  33 .Sh NAME
  34 .Nm timer_delete
  35 .Nd delete a per-process timer
  36 .Sh LIBRARY
  37 .Lb libc
  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 functions deletes the timer specified in the
  46 .Ar timerid
  47 argument.
  48 The
  49 .Ar timerid
  50 argument must point to valid timer id, created by
  51 .Xr timer_create 2 .
  52 If the deletion is successful, the timer is disarmed and deleted.
  53 Pending notification events (signals) may or may not be delivered.
  54 .Sh RETURN VALUES
  55 If successful, the
  56 .Fn timer_delete
  57 functions returns 0.
  58 Otherwise, it returns \-1, and sets
  59 .Dv errno
  60 to indicate error.
  61 .Sh ERRORS
  62 The
  63 .Fn timer_delete
  64 function will fail if:
  65 .Bl -tag -width Er
  66 .It Bq Er EINVAL
  67 The argument
  68 .Ar timerid
  69 is not a valid timer id.
  70 .El
  71 .Sh SEE ALSO
  72 .Xr timer_create 2 ,
  73 .Xr timer_getoverrun 2 ,
  74 .Xr timer_gettime 2 ,
  75 .Xr timer_settime 2
  76 .Sh STANDARDS
  77 .St -p1003.1b-93 ,
  78 .St -p1003.1i-95