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/share/man/man3/pthread_rwlockattr_setpshared.3,v 1.15 2007/10/22 10:08:01 ru Exp $
26.\" $DragonFly: src/lib/libc_r/man/pthread_rwlockattr_setpshared.3,v 1.3 2006/02/17 19:35:07 swildner Exp $
27.\"
28.Dd July 10, 2009
29.Dt PTHREAD_RWLOCKATTR_SETPSHARED 3
30.Os
31.Sh NAME
32.Nm pthread_rwlockattr_setpshared
33.Nd set the process shared attribute
34.Sh LIBRARY
35.Lb libpthread
36.Sh SYNOPSIS
37.In pthread.h
38.Ft int
39.Fn pthread_rwlockattr_setpshared "pthread_rwlockattr_t *attr" "int pshared"
40.Sh DESCRIPTION
41The
42.Fn pthread_rwlockattr_setpshared
43function sets the process shared attribute of
44.Fa attr
45to the value referenced by
46.Fa pshared .
47The
48.Fa pshared
49argument may be one of two values:
50.Bl -tag -width ".Dv PTHREAD_PROCESS_PRIVATE"
51.It Dv PTHREAD_PROCESS_SHARED
52Any thread of any process that has access to the memory where the
53read/write lock resides can manipulate the lock.
54.It Dv PTHREAD_PROCESS_PRIVATE
55Only threads created within the same process as the thread that
56initialized the read/write lock can manipulate the lock.
57This is
58the default value.
59.El
60.Sh RETURN VALUES
61If successful, the
62.Fn pthread_rwlockattr_setpshared
63function will return zero.
64Otherwise an error number will be returned
65to indicate the error.
66.Sh ERRORS
67The
68.Fn pthread_rwlockattr_setpshared
69function will fail if:
70.Bl -tag -width Er
71.It Bq Er EINVAL
72The value specified by
73.Fa attr
74or
75.Fa pshared
76is invalid.
77.El
78.Sh SEE ALSO
79.Xr pthread_rwlockattr_getpshared 3 ,
80.Xr pthread_rwlockattr_init 3 ,
81.Xr pthread_rwlock_init 3
82.Sh STANDARDS
83The
84.Fn pthread_rwlockattr_setpshared
85function is expected to conform to
86.St -susv2 .
87.Sh HISTORY
88The
89.Fn pthread_rwlockattr_setpshared
90function first appeared in
91.Fx 3.0 .
92.Sh BUGS
93The
94.Dv PTHREAD_PROCESS_SHARED
95attribute is not supported.
96