xref: /freebsd/lib/libsys/timer_delete.2 (revision 7fdf597e96a02165cfe22ff357b857d5fa15ed8a)
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.Dd September 11, 2000
29.Dt TIMER_DELETE 2
30.Os
31.Sh NAME
32.Nm timer_delete
33.Nd "delete a per-process timer (REALTIME)"
34.Sh LIBRARY
35.Lb librt
36.Sh SYNOPSIS
37.In time.h
38.Ft int
39.Fn timer_delete "timer_t timerid"
40.Sh DESCRIPTION
41The
42.Fn timer_delete
43system call
44deletes the specified timer,
45.Fa timerid ,
46previously created by the
47.Xr timer_create 2
48system call.
49If the timer is armed when
50.Fn timer_delete
51is called, the behavior is as if the timer is automatically disarmed before
52removal.
53Pending signals for the deleted timer are cleared.
54.Sh RETURN VALUES
55.Rv -std
56.Sh ERRORS
57The
58.Fn timer_delete
59system call
60will fail if:
61.Bl -tag -width Er
62.It Bq Er EINVAL
63The timer ID specified by
64.Fa timerid
65is not a valid timer ID.
66.El
67.Sh SEE ALSO
68.Xr timer_create 2
69.Sh STANDARDS
70The
71.Fn timer_delete
72system call conforms to
73.St -p1003.1-2004 .
74.Sh HISTORY
75Support for
76.Tn POSIX
77per-process timer first appeared in
78.Fx 7.0 .
79