xref: /openbsd-src/lib/libpthread/man/pthread_mutex_destroy.3 (revision 25b7f502516e2f1c6e01335bfd66c89e94faf9c4)
1*25b7f502Sstsp.\" $OpenBSD: pthread_mutex_destroy.3,v 1.11 2020/04/03 13:05:08 stsp Exp $
282d2d131Sfgsch.\"
3a278733dSd.\" Copyright (c) 1997 Brian Cully <shmit@kublai.com>
4a278733dSd.\" All rights reserved.
5a278733dSd.\"
6a278733dSd.\" Redistribution and use in source and binary forms, with or without
7a278733dSd.\" modification, are permitted provided that the following conditions
8a278733dSd.\" are met:
9a278733dSd.\" 1. Redistributions of source code must retain the above copyright
10a278733dSd.\"    notice, this list of conditions and the following disclaimer.
11a278733dSd.\" 2. Redistributions in binary form must reproduce the above copyright
12a278733dSd.\"    notice, this list of conditions and the following disclaimer in the
13a278733dSd.\"    documentation and/or other materials provided with the distribution.
14a278733dSd.\" 3. Neither the name of the author nor the names of any co-contributors
15a278733dSd.\"    may be used to endorse or promote products derived from this software
16a278733dSd.\"    without specific prior written permission.
17a278733dSd.\"
18a278733dSd.\" THIS SOFTWARE IS PROVIDED BY JOHN BIRRELL AND CONTRIBUTORS ``AS IS'' AND
19a278733dSd.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20a278733dSd.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21a278733dSd.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
22a278733dSd.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23a278733dSd.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24a278733dSd.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25a278733dSd.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26a278733dSd.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27a278733dSd.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28a278733dSd.\" SUCH DAMAGE.
29a278733dSd.\"
3074493c91Sd.\" $FreeBSD: pthread_mutex_destroy.3,v 1.5 1999/08/28 00:03:07 peter Exp $
3174493c91Sd.\"
32*25b7f502Sstsp.Dd $Mdocdate: April 3 2020 $
33a278733dSd.Dt PTHREAD_MUTEX_DESTROY 3
34c043c0f7Sd.Os
35a278733dSd.Sh NAME
36a278733dSd.Nm pthread_mutex_destroy
37a278733dSd.Nd free resources allocated for a mutex
38a278733dSd.Sh SYNOPSIS
3986f9d4cdStedu.In pthread.h
40a278733dSd.Ft int
41a278733dSd.Fn pthread_mutex_destroy "pthread_mutex_t *mutex"
42a278733dSd.Sh DESCRIPTION
43a278733dSdThe
44a278733dSd.Fn pthread_mutex_destroy
45a278733dSdfunction frees the resources allocated for
46a278733dSd.Fa mutex .
47a278733dSd.Sh RETURN VALUES
48a278733dSdIf successful,
49a278733dSd.Fn pthread_mutex_destroy
50a278733dSdwill return zero, otherwise an error number will be returned to
51a278733dSdindicate the error.
52a278733dSd.Sh ERRORS
53a278733dSd.Fn pthread_mutex_destroy
54a278733dSdwill fail if:
55a278733dSd.Bl -tag -width Er
56a278733dSd.It Bq Er EINVAL
57a278733dSdThe value specified by
58a278733dSd.Fa mutex
59a278733dSdis invalid.
60a278733dSd.It Bq Er EBUSY
61960f8fbdSderaadt.Fa mutex
62*25b7f502Sstspis locked or referenced by another thread.
63a278733dSd.El
64a278733dSd.Sh SEE ALSO
65a278733dSd.Xr pthread_mutex_init 3 ,
66a278733dSd.Xr pthread_mutex_lock 3 ,
67f8344ebdSd.Xr pthread_mutex_unlock 3
68a278733dSd.Sh STANDARDS
69a278733dSd.Fn pthread_mutex_destroy
7082d2d131Sfgschconforms to
7182d2d131Sfgsch.St -p1003.1-96 .
72