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