xref: /openbsd-src/lib/libpthread/man/pthread_rwlockattr_init.3 (revision 62a742911104f98b9185b2c6b6007d9b1c36396c)
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.\"	$Id: pthread_rwlockattr_init.3,v 1.2 1999/04/21 20:36:41 alex Exp $
26.\"	$OpenBSD: pthread_rwlockattr_init.3,v 1.2 1999/04/21 20:36:41 alex Exp $
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 SYNOPSIS
35.Fd #include <pthread.h>
36.Ft int
37.Fn pthread_rwlockattr_init "pthread_rwlockattr_t *attr"
38.Sh DESCRIPTION
39The
40.Fn pthread_rwlockattr_init
41function is used to initialize a read/write lock attributes object.
42.Sh RETURN VALUES
43If successful, the
44.Fn pthread_rwlockattr_init
45function will return zero.  Otherwise an error number will be returned
46to indicate the error.
47.Sh SEE ALSO
48.Xr pthread_rwlock_init 3 ,
49.Xr pthread_rwlockattr_destroy 3 ,
50.Xr pthread_rwlockattr_getpshared 3
51.Xr pthread_rwlockattr_setpshared 3
52.Sh STANDARDS
53The
54.Fn pthread_rwlockattr_init
55function is expected to conform to
56.St -susv2 .
57.Sh ERRORS
58.Fn pthread_rwlockattr_init
59will fail if:
60.Bl -tag -width Er
61.It Bq Er ENOMEM
62Insufficient memory exists to initialize the attribute object.
63.El
64.Sh HISTORY
65The
66.Fn pthread_rwlockattr_init
67function first appeared in
68.Ox 2.5 .
69