1.\" $NetBSD: timer_delete.2,v 1.4 2003/09/14 09:02:50 wiz 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.\" 3. All advertising materials mentioning features or use of this software 18.\" must display the following acknowledgement: 19.\" This product includes software developed by the NetBSD 20.\" Foundation, Inc. and its contributors. 21.\" 4. Neither the name of The NetBSD Foundation nor the names of its 22.\" contributors may be used to endorse or promote products derived 23.\" from this software without specific prior written permission. 24.\" 25.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 26.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 27.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 28.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 29.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 30.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 31.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 32.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 33.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 34.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 35.\" POSSIBILITY OF SUCH DAMAGE. 36.\" 37.Dd September 13, 2003 38.Dt TIMER_DELETE 2 39.Os 40.Sh NAME 41.Nm timer_delete 42.Nd delete a per-process timer 43.Sh LIBRARY 44.Lb libc 45.Sh SYNOPSIS 46.In time.h 47.Ft int 48.Fn timer_delete "timer_t timerid" 49.Sh DESCRIPTION 50The 51.Fn timer_delete 52functions deletes the timer specified in the 53.Ar timerid 54argument. 55The 56.Ar timerid 57argument must point to valid timer id, created by 58.Xr timer_create 2 . 59If the deletion is successful, the timer is disarmed and deleted. 60Pending notification events (signals) may or may not be delivered. 61.Sh RETURN VALUES 62If successful, the 63.Fn timer_delete 64functions returns 0. 65Otherwise, it returns \-1, and sets 66.Dv errno 67to indicate error. 68.Sh ERRORS 69The 70.Fn timer_delete 71function will fail if: 72.Bl -tag -width Er 73.It Bq Er EINVAL 74The argument 75.Ar timerid 76is not a valid timer id. 77.El 78.Sh SEE ALSO 79.Xr timer_create 2 , 80.Xr timer_getoverrun 2 , 81.Xr timer_gettime 2 , 82.Xr timer_settime 2 83.Sh STANDARDS 84.St -p1003.1b-93 , 85.St -p1003.1i-95 86