xref: /freebsd/share/man/man3/pthread_rwlockattr_getpshared.3 (revision dcb964fa34399f90c36f914e6b28e02d575562f4)
1c0e36632SAlexander Langer.\" Copyright (c) 1998 Alex Nash
2c0e36632SAlexander Langer.\" All rights reserved.
3c0e36632SAlexander Langer.\"
4c0e36632SAlexander Langer.\" Redistribution and use in source and binary forms, with or without
5c0e36632SAlexander Langer.\" modification, are permitted provided that the following conditions
6c0e36632SAlexander Langer.\" are met:
7c0e36632SAlexander Langer.\" 1. Redistributions of source code must retain the above copyright
8c0e36632SAlexander Langer.\"    notice, this list of conditions and the following disclaimer.
9c0e36632SAlexander Langer.\" 2. Redistributions in binary form must reproduce the above copyright
10c0e36632SAlexander Langer.\"    notice, this list of conditions and the following disclaimer in the
11c0e36632SAlexander Langer.\"    documentation and/or other materials provided with the distribution.
12c0e36632SAlexander Langer.\"
13c0e36632SAlexander Langer.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14c0e36632SAlexander Langer.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15c0e36632SAlexander Langer.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16c0e36632SAlexander Langer.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17c0e36632SAlexander Langer.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18c0e36632SAlexander Langer.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19c0e36632SAlexander Langer.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20c0e36632SAlexander Langer.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21c0e36632SAlexander Langer.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22c0e36632SAlexander Langer.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23c0e36632SAlexander Langer.\" SUCH DAMAGE.
24c0e36632SAlexander Langer.\"
25dcb964faSBruce Evans.\"	$Id: pthread_rwlockattr_getpshared.3,v 1.1 1998/09/07 19:01:43 alex Exp $
26c0e36632SAlexander Langer.\"
27c0e36632SAlexander Langer.Dd August 4, 1998
28c0e36632SAlexander Langer.Dt PTHREAD_RWLOCKATTR_GETPSHARED 3
29c0e36632SAlexander Langer.Os
30c0e36632SAlexander Langer.Sh NAME
31c0e36632SAlexander Langer.Nm pthread_rwlockattr_getpshared
32c0e36632SAlexander Langer.Nd set the process shared attribute
33c0e36632SAlexander Langer.Sh SYNOPSIS
34c0e36632SAlexander Langer.Fd #include <pthread.h>
35c0e36632SAlexander Langer.Ft int
36dcb964faSBruce Evans.Fn pthread_rwlockattr_getpshared "const pthread_rwlockattr_t *attr" "int *pshared"
37c0e36632SAlexander Langer.Sh DESCRIPTION
38c0e36632SAlexander LangerThe
39c0e36632SAlexander Langer.Fn pthread_rwlockattr_getpshared
40c0e36632SAlexander Langerfunction is used to get the process shared setting of a read/write
41c0e36632SAlexander Langerlock attribute object.  The setting is returned via
42c0e36632SAlexander Langer.Fa pshared ,
43c0e36632SAlexander Langerand may be one of two values:
44c0e36632SAlexander Langer.Bl -hang -offset flag -width 123456789012345678901234
45c0e36632SAlexander Langer.It Ar PTHREAD_PROCESS_SHARED
46c0e36632SAlexander LangerAny thread of any process that has access to the memory where the
47c0e36632SAlexander Langerread/write lock resides can manipulate the lock.
48c0e36632SAlexander Langer.It Ar PTHREAD_PROCESS_PRIVATE
49c0e36632SAlexander LangerOnly threads created within the same process as the thread that
50c0e36632SAlexander Langerinitialized the read/write lock can manipulate the lock.  This is
51c0e36632SAlexander Langerthe default value.
52c0e36632SAlexander Langer.El
53c0e36632SAlexander Langer.Sh RETURN VALUES
54c0e36632SAlexander LangerIf successful, the
55c0e36632SAlexander Langer.Fn pthread_rwlockattr_getpshared
56c0e36632SAlexander Langerfunction will return zero.  Otherwise an error number will be returned
57c0e36632SAlexander Langerto indicate the error.
58c0e36632SAlexander Langer.Sh SEE ALSO
59c0e36632SAlexander Langer.Xr pthread_rwlock_init 3 ,
60c0e36632SAlexander Langer.Xr pthread_rwlockattr_init 3 ,
61c0e36632SAlexander Langer.Xr pthread_rwlockattr_setpshared 3
62c0e36632SAlexander Langer.Sh STANDARDS
63c0e36632SAlexander LangerThe
64c0e36632SAlexander Langer.Fn pthread_rwlockattr_getpshared
65c0e36632SAlexander Langerfunction is expected to conform to
66c0e36632SAlexander Langer.St -susv2 .
67c0e36632SAlexander Langer.Sh ERRORS
68c0e36632SAlexander Langer.Fn pthread_rwlockattr_getpshared
69c0e36632SAlexander Langermay fail if:
70c0e36632SAlexander Langer.Bl -tag -width Er
71c0e36632SAlexander Langer.It Bq Er EINVAL
72c0e36632SAlexander LangerThe value specified by
73c0e36632SAlexander Langer.Fa attr
74c0e36632SAlexander Langeris invalid.
75c0e36632SAlexander Langer.El
76c0e36632SAlexander Langer.Sh HISTORY
77c0e36632SAlexander LangerThe
78c0e36632SAlexander Langer.Fn pthread_rwlockattr_getpshared
79c0e36632SAlexander Langerfunction first appeared in
80c0e36632SAlexander Langer.Fx 3.0 .
81