xref: /freebsd/lib/libc/gen/sem_destroy.3 (revision cbb3ec25236ba72f91cbdf23f8b78b9d1af0cedf)
1.\" Copyright (C) 2000 Jason Evans <jasone@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 February 15, 2000
29.Dt SEM_DESTROY 3
30.Os
31.Sh NAME
32.Nm sem_destroy
33.Nd destroy an unnamed semaphore
34.Sh LIBRARY
35.Lb libc
36.Sh SYNOPSIS
37.In semaphore.h
38.Ft int
39.Fn sem_destroy "sem_t *sem"
40.Sh DESCRIPTION
41The
42.Fn sem_destroy
43function destroys the unnamed semaphore pointed to by
44.Fa sem .
45After a successful call to
46.Fn sem_destroy ,
47.Fa sem
48is unusable until re-initialized by another call to
49.Xr sem_init 3 .
50.Sh RETURN VALUES
51.Rv -std sem_destroy
52.Sh ERRORS
53The
54.Fn sem_destroy
55function will fail if:
56.Bl -tag -width Er
57.It Bq Er EINVAL
58The
59.Fa sem
60argument
61points to an invalid semaphore.
62.It Bq Er EBUSY
63There are currently threads blocked on the semaphore that
64.Fa sem
65points to.
66.El
67.Sh SEE ALSO
68.Xr sem_init 3
69.Sh STANDARDS
70The
71.Fn sem_destroy
72function conforms to
73.St -p1003.1-96 .
74.Pp
75.Tn POSIX
76does not define the behavior of
77.Fn sem_destroy
78if called while there are threads blocked on
79.Fa sem ,
80but this implementation is guaranteed to return \-1 and set
81.Va errno
82to
83.Er EBUSY
84if there are threads blocked on
85.Fa sem .
86