xref: /netbsd-src/lib/libpthread/pthread_rwlockattr.3 (revision 946379e7b37692fc43f68eb0d1c10daa0a7f3b6c)
1.\" $NetBSD: pthread_rwlockattr.3,v 1.8 2010/07/09 08:51:28 jruoho Exp $
2.\"
3.\" Copyright (c) 2002 The NetBSD Foundation, Inc.
4.\" All rights reserved.
5.\" Redistribution and use in source and binary forms, with or without
6.\" modification, are permitted provided that the following conditions
7.\" are met:
8.\" 1. Redistributions of source code must retain the above copyright
9.\"    notice, this list of conditions and the following disclaimer.
10.\" 2. Redistributions in binary form must reproduce the above copyright
11.\"    notice, this list of conditions and the following disclaimer in the
12.\"    documentation and/or other materials provided with the distribution.
13.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
14.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
15.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
17.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
23.\" POSSIBILITY OF SUCH DAMAGE.
24.\"
25.\" Copyright (c) 1998 Alex Nash
26.\" All rights reserved.
27.\"
28.\" Redistribution and use in source and binary forms, with or without
29.\" modification, are permitted provided that the following conditions
30.\" are met:
31.\" 1. Redistributions of source code must retain the above copyright
32.\"    notice, this list of conditions and the following disclaimer.
33.\" 2. Redistributions in binary form must reproduce the above copyright
34.\"    notice, this list of conditions and the following disclaimer in the
35.\"    documentation and/or other materials provided with the distribution.
36.\"
37.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
38.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
39.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
40.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
41.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
42.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
43.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
44.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
45.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
46.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
47.\" SUCH DAMAGE.
48.\"
49.\" $FreeBSD: src/lib/libpthread/man/pthread_rwlockattr_init.3,v 1.7 2002/09/16 19:29:29 mini Exp $
50.\"
51.Dd July 9, 2010
52.Dt PTHREAD_RWLOCKATTR 3
53.Os
54.Sh NAME
55.Nm pthread_rwlockattr_init ,
56.Nm pthread_rwlockattr_destroy
57.Nd initialize or destroy read/write lock attributes
58.Sh LIBRARY
59.Lb libpthread
60.Sh SYNOPSIS
61.In pthread.h
62.Ft int
63.Fn pthread_rwlockattr_init "pthread_rwlockattr_t *attr"
64.Ft int
65.Fn pthread_rwlockattr_destroy "pthread_rwlockattr_t *attr"
66.Sh DESCRIPTION
67The
68.Fn pthread_rwlockattr_init
69function is used to initialize a read/write lock attributes object.
70.Pp
71The
72.Fn pthread_rwlockattr_destroy
73function is used to destroy a read/write lock attribute object
74previously created with
75.Fn pthread_rwlockattr_init .
76.Sh RETURN VALUES
77If successful, the
78.Fn pthread_rwlockattr_init
79and
80.Fn pthread_rwlockattr_destroy
81functions return zero.
82Otherwise an error number will be returned to indicate the error.
83.Sh ERRORS
84.Fn pthread_rwlockattr_init
85shall fail if:
86.Bl -tag -width Er
87.It Bq Er ENOMEM
88Insufficient memory exists to initialize the read/write lock attributes object.
89.El
90.Pp
91.Fn pthread_rwlockattr_init
92and
93.Fn pthread_rwlockattr_destroy
94may fail if:
95.Bl -tag -width Er
96.It Bq Er EINVAL
97The value specified by
98.Fa attr
99is invalid.
100.El
101.Sh SEE ALSO
102.Xr pthread_rwlock_init 3
103.Sh STANDARDS
104Both functions conform to
105.St -p1003.1-2001 .
106