xref: /freebsd/share/man/man3/pthread_mutex_destroy.3 (revision 5ca8e32633c4ffbbcd6762e5888b6a4ba0708c6c)
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.Dd July 29, 1998
29.Dt PTHREAD_MUTEX_DESTROY 3
30.Os
31.Sh NAME
32.Nm pthread_mutex_destroy
33.Nd free resources allocated for a mutex
34.Sh LIBRARY
35.Lb libpthread
36.Sh SYNOPSIS
37.In pthread.h
38.Ft int
39.Fn pthread_mutex_destroy "pthread_mutex_t *mutex"
40.Sh DESCRIPTION
41The
42.Fn pthread_mutex_destroy
43function frees the resources allocated for
44.Fa mutex .
45.Sh RETURN VALUES
46If successful,
47.Fn pthread_mutex_destroy
48will return zero, otherwise an error number will be returned to
49indicate the error.
50.Sh ERRORS
51The
52.Fn pthread_mutex_destroy
53function will fail if:
54.Bl -tag -width Er
55.It Bq Er EINVAL
56The value specified by
57.Fa mutex
58is invalid.
59.It Bq Er EBUSY
60.Fa Mutex
61is locked by another thread.
62.El
63.Sh SEE ALSO
64.Xr pthread_mutex_init 3 ,
65.Xr pthread_mutex_lock 3 ,
66.Xr pthread_mutex_trylock 3 ,
67.Xr pthread_mutex_unlock 3
68.Sh STANDARDS
69The
70.Fn pthread_mutex_destroy
71function conforms to
72.St -p1003.1-96 .
73