xref: /freebsd/share/man/man3/pthread_mutex_unlock.3 (revision 380a989b3223d455375b4fae70fd0b9bdd43bafb)
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 30, 1998
29.Dt PTHREAD_MUTEX_UNLOCK 3
30.Os BSD 4
31.Sh NAME
32.Nm pthread_mutex_unlock
33.Nd unlock a mutex
34.Sh SYNOPSIS
35.Fd #include <pthread.h>
36.Ft int
37.Fn pthread_mutex_unlock "pthread_mutex_t *mutex"
38.Sh DESCRIPTION
39If the current thread holds the lock on
40.Fa mutex ,
41then the
42.Fn pthread_mutex_unlock
43function unlocks
44.Fa mutex .
45.Sh RETURN VALUES
46If successful,
47.Fn pthread_mutex_unlock
48will return zero, otherwise an error number will be returned to
49indicate the error.
50.Sh ERRORS
51.Fn pthread_mutex_trylock
52will fail if:
53.Bl -tag -width Er
54.It Bq Er EINVAL
55The value specified by
56.Fa mutex
57is invalid.
58.It Bq Er EPERM
59The current thread does not hold a lock on
60.Fa mutex .
61.El
62.Pp
63.Sh SEE ALSO
64.Xr pthread_mutex_destroy 3 ,
65.Xr pthread_mutex_init 3 ,
66.Xr pthread_mutex_lock 3 ,
67.Xr pthread_mutex_trylock 3
68.Sh STANDARDS
69.Fn pthread_mutex_unlock
70conforms to ISO/IEC 9945-1 ANSI/IEEE
71.Pq Dq Tn POSIX
72Std 1003.1 Second Edition 1996-07-12.
73