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