xref: /freebsd/share/man/man3/pthread_rwlockattr_getpshared.3 (revision 729362425c09cf6b362366aabc6fb547eee8035a)
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$
26.\"
27.Dd March 22, 1999
28.Dt PTHREAD_RWLOCKATTR_GETPSHARED 3
29.Os
30.Sh NAME
31.Nm pthread_rwlockattr_getpshared
32.Nd get the process shared attribute
33.Sh LIBRARY
34.Lb libc_r
35.Sh SYNOPSIS
36.In pthread.h
37.Ft int
38.Fn pthread_rwlockattr_getpshared "const pthread_rwlockattr_t *attr" "int *pshared"
39.Sh DESCRIPTION
40The
41.Fn pthread_rwlockattr_getpshared
42function is used to get the process shared setting of a read/write
43lock attribute object.  The setting is returned via
44.Fa pshared ,
45and may be one of two values:
46.Bl -tag -width PTHREAD_PROCESS_PRIVATE
47.It Dv 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 Dv PTHREAD_PROCESS_PRIVATE
51Only threads created within the same process as the thread that
52initialized the read/write lock can manipulate the lock.  This is
53the default value.
54.El
55.Sh RETURN VALUES
56If successful, the
57.Fn pthread_rwlockattr_getpshared
58function will return zero.  Otherwise an error number will be returned
59to indicate the error.
60.Sh SEE ALSO
61.Xr pthread_rwlockattr_init 3 ,
62.Xr pthread_rwlockattr_setpshared 3 ,
63.Xr pthread_rwlock_init 3
64.Sh STANDARDS
65The
66.Fn pthread_rwlockattr_getpshared
67function is expected to conform to
68.St -susv2 .
69.Sh ERRORS
70The
71.Fn pthread_rwlockattr_getpshared
72function may fail if:
73.Bl -tag -width Er
74.It Bq Er EINVAL
75The value specified by
76.Fa attr
77is invalid.
78.El
79.Sh HISTORY
80The
81.Fn pthread_rwlockattr_getpshared
82function first appeared in
83.Fx 3.0 .
84