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