xref: /freebsd/share/man/man3/pthread_rwlockattr_setpshared.3 (revision ec7452f103d56cccf279cec74a22025f980bbda5)
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 August 4, 1998
28.Dt PTHREAD_RWLOCKATTR_SETPSHARED 3
29.Os
30.Sh NAME
31.Nm pthread_rwlockattr_setpshared
32.Nd set the process shared attribute
33.Sh LIBRARY
34.Lb libc_r
35.Lb libpthread
36.Sh SYNOPSIS
37.In pthread.h
38.Ft int
39.Fn pthread_rwlockattr_setpshared "pthread_rwlockattr_t *attr" "int pshared"
40.Sh DESCRIPTION
41The
42.Fn pthread_rwlockattr_setpshared
43function sets the process shared attribute of
44.Fa attr
45to the value referenced by
46.Fa pshared .
47The
48.Fa pshared
49argument may be one of two values:
50.Bl -tag -width PTHREAD_PROCESS_PRIVATE
51.It Dv PTHREAD_PROCESS_SHARED
52Any thread of any process that has access to the memory where the
53read/write lock resides can manipulate the lock.
54.It Dv PTHREAD_PROCESS_PRIVATE
55Only threads created within the same process as the thread that
56initialized the read/write lock can manipulate the lock.  This is
57the default value.
58.El
59.Sh RETURN VALUES
60If successful, the
61.Fn pthread_rwlockattr_setpshared
62function will return zero.  Otherwise an error number will be returned
63to indicate the error.
64.Sh SEE ALSO
65.Xr pthread_rwlockattr_getpshared 3 ,
66.Xr pthread_rwlockattr_init 3 ,
67.Xr pthread_rwlock_init 3
68.Sh STANDARDS
69The
70.Fn pthread_rwlockattr_setpshared
71function is expected to conform to
72.St -susv2 .
73.Sh ERRORS
74The
75.Fn pthread_rwlockattr_setpshared
76function will fail if:
77.Bl -tag -width Er
78.It Bq Er EINVAL
79The value specified by
80.Fa attr
81or
82.Fa pshared
83is invalid.
84.El
85.Sh HISTORY
86The
87.Fn pthread_rwlockattr_setpshared
88function first appeared in
89.Fx 3.0 .
90.Sh BUGS
91The
92.Dv PTHREAD_PROCESS_SHARED
93attribute is not supported.
94