1.\" $OpenBSD: pthread_rwlockattr_getpshared.3,v 1.10 2013/06/05 03:44:50 tedu 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_getpshared.3,v 1.4 1999/08/28 00:03:10 peter Exp $
27.\"
28.Dd $Mdocdate: June 5 2013 $
29.Dt PTHREAD_RWLOCKATTR_GETPSHARED 3
30.Os
31.Sh NAME
32.Nm pthread_rwlockattr_getpshared
33.Nd get the process shared attribute
34.Sh SYNOPSIS
35.In pthread.h
36.Ft int
37.Fn pthread_rwlockattr_getpshared "const pthread_rwlockattr_t *attr" "int *pshared"
38.Sh DESCRIPTION
39The
40.Fn pthread_rwlockattr_getpshared
41function is used to get the process shared setting of a read/write
42lock attribute object.
43The setting is returned via
44.Fa pshared ,
45and may be one of two values:
46.Bl -hang -offset flag -width 123456789012345678901234
47.It Ar PTHREAD_PROCESS_SHARED
48Any thread of any process that has access to the memory where the
49read/write lock resides can manipulate the lock.
50.It Ar PTHREAD_PROCESS_PRIVATE
51Only threads created within the same process as the thread that
52initialized the read/write lock can manipulate the lock.
53This is the default value.
54.El
55.Sh RETURN VALUES
56If successful, the
57.Fn pthread_rwlockattr_getpshared
58function will return zero.
59Otherwise an error number will be returned to indicate the error.
60.Sh ERRORS
61.Fn pthread_rwlockattr_getpshared
62may fail if:
63.Bl -tag -width Er
64.It Bq Er EINVAL
65The value specified by
66.Fa attr
67is invalid.
68.El
69.Sh SEE ALSO
70.Xr pthread_rwlock_init 3 ,
71.Xr pthread_rwlockattr_init 3 ,
72.Xr pthread_rwlockattr_setpshared 3
73.Sh STANDARDS
74The
75.Fn pthread_rwlockattr_getpshared
76function is expected to conform to
77.St -susv2 .
78.Sh HISTORY
79The
80.Fn pthread_rwlockattr_getpshared
81function first appeared in
82.Fx 3.0
83and
84.Ox 2.5 .
85