1.\" $OpenBSD: pthread_rwlockattr_setpshared.3,v 1.9 2007/05/31 19:19:37 jmc Exp $
2.\" Copyright (c) 1998 Alex Nash
3.\" All rights reserved.
4.\"
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.\"
14.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24.\" SUCH DAMAGE.
25.\"
26.\" $FreeBSD: pthread_rwlockattr_setpshared.3,v 1.2 1999/08/28 00:03:11 peter Exp $
27.\"
28.Dd $Mdocdate: May 31 2007 $
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 SYNOPSIS
35.Fd #include <pthread.h>
36.Ft int
37.Fn pthread_rwlockattr_setpshared "pthread_rwlockattr_t *attr" "int pshared"
38.Sh DESCRIPTION
39The
40.Fn pthread_rwlockattr_setpshared
41function sets the process shared attribute of
42.Fa attr
43to the value referenced by
44.Fa pshared .
45.Fa pshared
46may be one of two values:
47.Bl -hang -offset flag -width 123456789012345678901234
48.It Ar 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 Ar 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 the default value.
55.El
56.Sh RETURN VALUES
57If successful, the
58.Fn pthread_rwlockattr_setpshared
59function will return zero.
60Otherwise an error number will be returned to indicate the error.
61.Sh ERRORS
62.Fn pthread_rwlockattr_setpshared
63will fail if:
64.Bl -tag -width Er
65.It Bq Er EINVAL
66The value specified by
67.Fa attr
68or
69.Fa pshared
70is invalid.
71.El
72.Sh SEE ALSO
73.Xr pthread_rwlock_init 3 ,
74.Xr pthread_rwlockattr_init 3
75.Sh STANDARDS
76The
77.Fn pthread_rwlockattr_setpshared
78function is expected to conform to
79.St -susv2 .
80.Sh HISTORY
81The
82.Fn pthread_rwlockattr_setpshared
83function first appeared in
84.Fx 3.0
85and
86.Ox 2.5 .
87.Sh BUGS
88The PTHREAD_PROCESS_SHARED attribute is not supported.
89