Merge branch 'master' of ssh://crater.dragonflybsd.org/repository/git/dragonfly
[dragonfly.git] / lib / libpthread / pthread_rwlock_unlock.3
1 .\" Copyright (c) 1998 Alex Nash
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 .\"
13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23 .\" SUCH DAMAGE.
24 .\"
25 .\" $FreeBSD: src/share/man/man3/pthread_rwlock_unlock.3,v 1.10 2007/10/22 10:08:00 ru Exp $
26 .\" $DragonFly: src/lib/libc_r/man/pthread_rwlock_unlock.3,v 1.3 2006/02/17 19:35:07 swildner Exp $
27 .\"
28 .Dd July 10, 2009
29 .Dt PTHREAD_RWLOCK_UNLOCK 3
30 .Os
31 .Sh NAME
32 .Nm pthread_rwlock_unlock
33 .Nd release a read/write lock
34 .Sh LIBRARY
35 .Lb libpthread
36 .Sh SYNOPSIS
37 .In pthread.h
38 .Ft int
39 .Fn pthread_rwlock_unlock "pthread_rwlock_t *lock"
40 .Sh DESCRIPTION
41 The
42 .Fn pthread_rwlock_unlock
43 function is used to release the read/write lock previously obtained by
44 .Fn pthread_rwlock_rdlock ,
45 .Fn pthread_rwlock_wrlock ,
46 .Fn pthread_rwlock_tryrdlock ,
47 or
48 .Fn pthread_rwlock_trywrlock .
49 .Sh RETURN VALUES
50 If successful, the
51 .Fn pthread_rwlock_unlock
52 function will return zero.
53 Otherwise an error number will be returned
54 to indicate the error.
55 .Pp
56 The results are undefined if
57 .Fa lock
58 is not held by the calling thread.
59 .Sh ERRORS
60 The
61 .Fn pthread_rwlock_unlock
62 function may fail if:
63 .Bl -tag -width Er
64 .It Bq Er EINVAL
65 The value specified by
66 .Fa lock
67 is invalid.
68 .It Bq Er EPERM
69 The current thread does not own the read/write lock.
70 .El
71 .Sh SEE ALSO
72 .Xr pthread_rwlock_rdlock 3 ,
73 .Xr pthread_rwlock_wrlock 3
74 .Sh STANDARDS
75 The
76 .Fn pthread_rwlock_unlock
77 function is expected to conform to
78 .St -susv2 .
79 .Sh HISTORY
80 The
81 .Fn pthread_rwlock_unlock
82 function first appeared in
83 .Fx 3.0 .