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