xref: /openbsd/lib/libpthread/man/sem_destroy.3 (revision 9c42db49)
1.\" $OpenBSD: sem_destroy.3,v 1.4 2005/07/14 14:10:50 jmc Exp $
2.\"
3.\" Copyright (C) 2000 Jason Evans <jasone@FreeBSD.org>.
4.\" All rights reserved.
5.\"
6.\" Redistribution and use in source and binary forms, with or without
7.\" modification, are permitted provided that the following conditions
8.\" are met:
9.\" 1. Redistributions of source code must retain the above copyright
10.\"    notice(s), this list of conditions and the following disclaimer as
11.\"    the first lines of this file unmodified other than the possible
12.\"    addition of one or more copyright notices.
13.\" 2. Redistributions in binary form must reproduce the above copyright
14.\"    notice(s), this list of conditions and the following disclaimer in
15.\"    the documentation and/or other materials provided with the
16.\"    distribution.
17.\"
18.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) ``AS IS'' AND ANY
19.\" EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
21.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT HOLDER(S) BE
22.\" LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
25.\" BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
26.\" WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
27.\" OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
28.\" EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29.\"
30.\" $FreeBSD: src/lib/libc_r/man/sem_destroy.3,v 1.9 2001/10/01 16:09:09 ru Exp $
31.Dd February 15, 2000
32.Dt SEM_DESTROY 3
33.Os
34.Sh NAME
35.Nm sem_destroy
36.Nd destroy an unnamed semaphore
37.Sh SYNOPSIS
38.Fd #include <semaphore.h>
39.Ft int
40.Fn sem_destroy "sem_t *sem"
41.Sh DESCRIPTION
42The
43.Fn sem_destroy
44function destroys the unnamed semaphore pointed to by
45.Fa sem .
46After a successful call to
47.Fn sem_destroy ,
48.Fa sem
49is unusable until re-initialized by another call to
50.Fn sem_init .
51.Sh RETURN VALUES
52.Rv -std sem_destroy
53.Sh ERRORS
54.Fn sem_destroy
55will fail if:
56.Bl -tag -width Er
57.It Bq Er EINVAL
58.Fa sem
59points to an invalid semaphore.
60.It Bq Er EBUSY
61There are currently threads blocked on the semaphore that
62.Fa sem
63points to.
64.El
65.Sh SEE ALSO
66.Xr sem_getvalue 3 ,
67.Xr sem_init 3 ,
68.Xr sem_open 3 ,
69.Xr sem_post 3 ,
70.Xr sem_wait 3
71.Sh STANDARDS
72.Fn sem_destroy
73conforms to
74.St -p1003.1-96 .
75.Pp
76POSIX does 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