Move pthread* manpages to lib/libpthread as they are not libc_r specific.
[dragonfly.git] / lib / libpthread / pthread_rwlockattr_init.3
CommitLineData
984263bc
MD
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/lib/libc_r/man/pthread_rwlockattr_init.3,v 1.3.2.3 2001/12/17 10:08:26 ru Exp $
0b84df5c 26.\" $DragonFly: src/lib/libc_r/man/pthread_rwlockattr_init.3,v 1.3 2006/02/17 19:35:07 swildner Exp $
984263bc
MD
27.\"
28.Dd August 4, 1998
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 libc_r
36.Sh SYNOPSIS
37.In pthread.h
38.Ft int
39.Fn pthread_rwlockattr_init "pthread_rwlockattr_t *attr"
40.Sh DESCRIPTION
41The
42.Fn pthread_rwlockattr_init
43function is used to initialize a read/write lock attributes object.
44.Sh RETURN VALUES
45If successful, the
46.Fn pthread_rwlockattr_init
47function will return zero. Otherwise an error number will be returned
48to indicate the error.
0b84df5c
SW
49.Sh ERRORS
50.Fn pthread_rwlockattr_init
51will fail if:
52.Bl -tag -width Er
53.It Bq Er ENOMEM
54Insufficient memory exists to initialize the attribute object.
55.El
984263bc
MD
56.Sh SEE ALSO
57.Xr pthread_rwlockattr_destroy 3 ,
58.Xr pthread_rwlockattr_getpshared 3 ,
59.Xr pthread_rwlockattr_setpshared 3 ,
60.Xr pthread_rwlock_init 3
61.Sh STANDARDS
62The
63.Fn pthread_rwlockattr_init
64function is expected to conform to
65.St -susv2 .
984263bc
MD
66.Sh HISTORY
67The
68.Fn pthread_rwlockattr_init
69function first appeared in
70.Fx 3.0 .