xref: /freebsd/share/man/man3/pthread_rwlockattr_init.3 (revision 2a4a1db342263067035ce69a4017c645da63455d)
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$
26.\"
27.Dd August 4, 1998
28.Dt PTHREAD_RWLOCKATTR_INIT 3
29.Os
30.Sh NAME
31.Nm pthread_rwlockattr_init
32.Nd initialize a read/write lock
33.Sh LIBRARY
34.Lb libc_r
35.Sh SYNOPSIS
36.In pthread.h
37.Ft int
38.Fn pthread_rwlockattr_init "pthread_rwlockattr_t *attr"
39.Sh DESCRIPTION
40The
41.Fn pthread_rwlockattr_init
42function is used to initialize a read/write lock attributes object.
43.Sh RETURN VALUES
44If successful, the
45.Fn pthread_rwlockattr_init
46function will return zero.  Otherwise an error number will be returned
47to indicate the error.
48.Sh SEE ALSO
49.Xr pthread_rwlockattr_destroy 3 ,
50.Xr pthread_rwlockattr_getpshared 3 ,
51.Xr pthread_rwlockattr_setpshared 3 ,
52.Xr pthread_rwlock_init 3
53.Sh STANDARDS
54The
55.Fn pthread_rwlockattr_init
56function is expected to conform to
57.St -susv2 .
58.Sh ERRORS
59.Fn pthread_rwlockattr_init
60will fail if:
61.Bl -tag -width Er
62.It Bq Er ENOMEM
63Insufficient memory exists to initialize the attribute object.
64.El
65.Sh HISTORY
66The
67.Fn pthread_rwlockattr_init
68function first appeared in
69.Fx 3.0 .
70