xref: /freebsd/share/man/man3/pthread_mutex_destroy.3 (revision 09a53ad8f1318c5daae6cfb19d97f4f6459f0013)
1.\" Copyright (c) 1997 Brian Cully <shmit@kublai.com>
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, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\" 3. Neither the name of the author nor the names of any co-contributors
13.\"    may be used to endorse or promote products derived from this software
14.\"    without specific prior written permission.
15.\"
16.\" THIS SOFTWARE IS PROVIDED BY JOHN BIRRELL AND CONTRIBUTORS ``AS IS'' AND
17.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
20.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26.\" SUCH DAMAGE.
27.\"
28.\" $FreeBSD$
29.\"
30.Dd July 29, 1998
31.Dt PTHREAD_MUTEX_DESTROY 3
32.Os
33.Sh NAME
34.Nm pthread_mutex_destroy
35.Nd free resources allocated for a mutex
36.Sh LIBRARY
37.Lb libpthread
38.Sh SYNOPSIS
39.In pthread.h
40.Ft int
41.Fn pthread_mutex_destroy "pthread_mutex_t *mutex"
42.Sh DESCRIPTION
43The
44.Fn pthread_mutex_destroy
45function frees the resources allocated for
46.Fa mutex .
47.Sh RETURN VALUES
48If successful,
49.Fn pthread_mutex_destroy
50will return zero, otherwise an error number will be returned to
51indicate the error.
52.Sh ERRORS
53The
54.Fn pthread_mutex_destroy
55function will fail if:
56.Bl -tag -width Er
57.It Bq Er EINVAL
58The value specified by
59.Fa mutex
60is invalid.
61.It Bq Er EBUSY
62.Fa Mutex
63is locked by another thread.
64.El
65.Sh SEE ALSO
66.Xr pthread_mutex_init 3 ,
67.Xr pthread_mutex_lock 3 ,
68.Xr pthread_mutex_trylock 3 ,
69.Xr pthread_mutex_unlock 3
70.Sh STANDARDS
71The
72.Fn pthread_mutex_destroy
73function conforms to
74.St -p1003.1-96 .
75