xref: /freebsd-14.2/lib/libc/sys/timer_delete.2 (revision bb5eebe6)
1.\"
2.\" Redistribution and use in source and binary forms, with or without
3.\" modification, are permitted provided that the following conditions
4.\" are met:
5.\" 1. Redistributions of source code must retain the above copyright
6.\"    notice(s), this list of conditions and the following disclaimer as
7.\"    the first lines of this file unmodified other than the possible
8.\"    addition of one or more copyright notices.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice(s), this list of conditions and the following disclaimer in
11.\"    the documentation and/or other materials provided with the
12.\"    distribution.
13.\"
14.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) ``AS IS'' AND ANY
15.\" EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
17.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT HOLDER(S) BE
18.\" LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
19.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
20.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
21.\" BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
22.\" WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
23.\" OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
24.\" EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25.\"
26.\" $FreeBSD$
27.\"
28.Dd Sep 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 libc
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
43deletes the specified timer,
44.Fa timerid ,
45previously created by the
46.Fn timer_create
47function. If the timer is armed when
48.Fn timer_delete
49is called, the behavior is as if the timer is automatically disarmed before
50removal. Pending signals for the deleted timer is cleared.
51.Sh RETURN VALUES
52If successful, the
53.Fn timer_delete
54function shall return a value of zero. Otherwise, the function shall return
55a value of -1 and set errno to indicate the error.
56.Sh ERRORS
57The
58.Fn timer_delete
59will fail if:
60.Bl -tag -width Er
61.It Bq Er EINVAL
62The timer ID specified by timerid is not a valid timer ID.
63.El
64.Sh SEE ALSO
65.Xr timer_create 2
66.Sh STANDARDS
67The
68.Fn timer_delete
69function conforms to
70.St -p1003.1-96 .
71