Blame man-pages-posix-2013-a/man3p/pthread_rwlockattr_getpshared.3p

Packit 7cfc04
'\" et
Packit 7cfc04
.TH PTHREAD_RWLOCKATTR_GETPSHARED "3P" 2013 "IEEE/The Open Group" "POSIX Programmer's Manual"
Packit 7cfc04
.SH PROLOG
Packit 7cfc04
This manual page is part of the POSIX Programmer's Manual.
Packit 7cfc04
The Linux implementation of this interface may differ (consult
Packit 7cfc04
the corresponding Linux manual page for details of Linux behavior),
Packit 7cfc04
or the interface may not be implemented on Linux.
Packit 7cfc04
Packit 7cfc04
.SH NAME
Packit 7cfc04
pthread_rwlockattr_getpshared,
Packit 7cfc04
pthread_rwlockattr_setpshared
Packit 7cfc04
\(em get and set the process-shared attribute of the read-write lock
Packit 7cfc04
attributes object
Packit 7cfc04
.SH SYNOPSIS
Packit 7cfc04
.LP
Packit 7cfc04
.nf
Packit 7cfc04
#include <pthread.h>
Packit 7cfc04
.P
Packit 7cfc04
int pthread_rwlockattr_getpshared(const pthread_rwlockattr_t
Packit 7cfc04
    *restrict \fIattr\fP, int *restrict \fIpshared\fP);
Packit 7cfc04
int pthread_rwlockattr_setpshared(pthread_rwlockattr_t *\fIattr\fP,
Packit 7cfc04
    int \fIpshared\fP);
Packit 7cfc04
.fi
Packit 7cfc04
.SH DESCRIPTION
Packit 7cfc04
The
Packit 7cfc04
\fIpthread_rwlockattr_getpshared\fR()
Packit 7cfc04
function shall obtain the value of the
Packit 7cfc04
.IR process-shared
Packit 7cfc04
attribute from the initialized attributes object referenced by
Packit 7cfc04
.IR attr .
Packit 7cfc04
The
Packit 7cfc04
\fIpthread_rwlockattr_setpshared\fR()
Packit 7cfc04
function shall set the
Packit 7cfc04
.IR process-shared
Packit 7cfc04
attribute in an initialized attributes object referenced by
Packit 7cfc04
.IR attr .
Packit 7cfc04
.P
Packit 7cfc04
The
Packit 7cfc04
.IR process-shared
Packit 7cfc04
attribute shall be set to PTHREAD_PROCESS_SHARED to
Packit 7cfc04
permit a read-write lock to be operated upon by any thread that has
Packit 7cfc04
access to the memory where the read-write lock is allocated, even if
Packit 7cfc04
the read-write lock is allocated in memory that is shared by multiple
Packit 7cfc04
processes. If the
Packit 7cfc04
.IR process-shared
Packit 7cfc04
attribute is PTHREAD_PROCESS_PRIVATE, the
Packit 7cfc04
read-write lock shall only be operated upon by threads created within
Packit 7cfc04
the same process as the thread that initialized the read-write lock; if
Packit 7cfc04
threads of differing processes attempt to operate on such a read-write
Packit 7cfc04
lock, the behavior is undefined. The default value of the
Packit 7cfc04
.IR process-shared
Packit 7cfc04
attribute shall be PTHREAD_PROCESS_PRIVATE.
Packit 7cfc04
.P
Packit 7cfc04
Additional attributes, their default values, and the names of the
Packit 7cfc04
associated functions to get and set those attribute values are
Packit 7cfc04
implementation-defined.
Packit 7cfc04
.P
Packit 7cfc04
The behavior is undefined if the value specified by the
Packit 7cfc04
.IR attr
Packit 7cfc04
argument to
Packit 7cfc04
\fIpthread_rwlockattr_getpshared\fR()
Packit 7cfc04
or
Packit 7cfc04
\fIpthread_rwlockattr_setpshared\fR()
Packit 7cfc04
does not refer to an initialized read-write lock attributes object.
Packit 7cfc04
.SH "RETURN VALUE"
Packit 7cfc04
Upon successful completion, the
Packit 7cfc04
\fIpthread_rwlockattr_getpshared\fR()
Packit 7cfc04
function shall return zero and store the value of the
Packit 7cfc04
.IR process-shared
Packit 7cfc04
attribute of
Packit 7cfc04
.IR attr
Packit 7cfc04
into the object referenced by the
Packit 7cfc04
.IR pshared
Packit 7cfc04
parameter. Otherwise, an error number shall be returned to indicate the
Packit 7cfc04
error.
Packit 7cfc04
.P
Packit 7cfc04
If successful, the
Packit 7cfc04
\fIpthread_rwlockattr_setpshared\fR()
Packit 7cfc04
function shall return zero; otherwise, an error number shall be
Packit 7cfc04
returned to indicate the error.
Packit 7cfc04
.SH ERRORS
Packit 7cfc04
The
Packit 7cfc04
\fIpthread_rwlockattr_setpshared\fR()
Packit 7cfc04
function may fail if:
Packit 7cfc04
.TP
Packit 7cfc04
.BR EINVAL
Packit 7cfc04
The new value specified for the attribute is outside the range of legal
Packit 7cfc04
values for that attribute.
Packit 7cfc04
.P
Packit 7cfc04
These functions shall not return an error code of
Packit 7cfc04
.BR [EINTR] .
Packit 7cfc04
.LP
Packit 7cfc04
.IR "The following sections are informative."
Packit 7cfc04
.SH EXAMPLES
Packit 7cfc04
None.
Packit 7cfc04
.SH "APPLICATION USAGE"
Packit 7cfc04
None.
Packit 7cfc04
.SH RATIONALE
Packit 7cfc04
None.
Packit 7cfc04
.SH "FUTURE DIRECTIONS"
Packit 7cfc04
None.
Packit 7cfc04
.SH "SEE ALSO"
Packit 7cfc04
.IR "\fIpthread_rwlock_destroy\fR\^(\|)",
Packit 7cfc04
.IR "\fIpthread_rwlockattr_destroy\fR\^(\|)"
Packit 7cfc04
.P
Packit 7cfc04
The Base Definitions volume of POSIX.1\(hy2008,
Packit 7cfc04
.IR "\fB<pthread.h>\fP"
Packit 7cfc04
.SH COPYRIGHT
Packit 7cfc04
Portions of this text are reprinted and reproduced in electronic form
Packit 7cfc04
from IEEE Std 1003.1, 2013 Edition, Standard for Information Technology
Packit 7cfc04
-- Portable Operating System Interface (POSIX), The Open Group Base
Packit 7cfc04
Specifications Issue 7, Copyright (C) 2013 by the Institute of
Packit 7cfc04
Electrical and Electronics Engineers, Inc and The Open Group.
Packit 7cfc04
(This is POSIX.1-2008 with the 2013 Technical Corrigendum 1 applied.) In the
Packit 7cfc04
event of any discrepancy between this version and the original IEEE and
Packit 7cfc04
The Open Group Standard, the original IEEE and The Open Group Standard
Packit 7cfc04
is the referee document. The original Standard can be obtained online at
Packit 7cfc04
http://www.unix.org/online.html .
Packit 7cfc04
Packit 7cfc04
Any typographical or formatting errors that appear
Packit 7cfc04
in this page are most likely
Packit 7cfc04
to have been introduced during the conversion of the source files to
Packit 7cfc04
man page format. To report such errors, see
Packit 7cfc04
https://www.kernel.org/doc/man-pages/reporting_bugs.html .