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