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