Merge remote branch 'crater/vendor/MDOCML' into HEAD
[dragonfly.git] / lib / libpthread / pthread_rwlockattr_init.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_rwlockattr_init.3,v 1.13 2007/10/22 10:08:00 ru Exp $
26 .\" $DragonFly: src/lib/libc_r/man/pthread_rwlockattr_init.3,v 1.3 2006/02/17 19:35:07 swildner Exp $
27 .\"
28 .Dd July 10, 2009
29 .Dt PTHREAD_RWLOCKATTR_INIT 3
30 .Os
31 .Sh NAME
32 .Nm pthread_rwlockattr_init
33 .Nd initialize a read/write lock
34 .Sh LIBRARY
35 .Lb libpthread
36 .Sh SYNOPSIS
37 .In pthread.h
38 .Ft int
39 .Fn pthread_rwlockattr_init "pthread_rwlockattr_t *attr"
40 .Sh DESCRIPTION
41 The
42 .Fn pthread_rwlockattr_init
43 function is used to initialize a read/write lock attributes object.
44 .Sh RETURN VALUES
45 If successful, the
46 .Fn pthread_rwlockattr_init
47 function will return zero.
48 Otherwise an error number will be returned
49 to indicate the error.
50 .Sh ERRORS
51 The
52 .Fn pthread_rwlockattr_init
53 function will fail if:
54 .Bl -tag -width Er
55 .It Bq Er ENOMEM
56 Insufficient memory exists to initialize the attribute object.
57 .El
58 .Sh SEE ALSO
59 .Xr pthread_rwlockattr_destroy 3 ,
60 .Xr pthread_rwlockattr_getpshared 3 ,
61 .Xr pthread_rwlockattr_setpshared 3 ,
62 .Xr pthread_rwlock_init 3
63 .Sh STANDARDS
64 The
65 .Fn pthread_rwlockattr_init
66 function is expected to conform to
67 .St -susv2 .
68 .Sh HISTORY
69 The
70 .Fn pthread_rwlockattr_init
71 function first appeared in
72 .Fx 3.0 .