PTHREAD_MUTEXATTR_GETPSHAREDP(O3S)IX Programmer's MaPnTuHaRlEAD_MUTEXATTR_GETPSHARED(3)



PPRROOLLOOGG
       This manual page is part of the POSIX Programmer's Manual.  The OS
       implementation of this interface may differ (consult the corresponding
       OS manual page for details of OS behavior), or the interface may not be
       implemented on OS.

NNAAMMEE
       pthread_mutexattr_getpshared, pthread_mutexattr_setpshared -- get and
       set the process-shared attribute

SSYYNNOOPPSSIISS
       #include <pthread.h>

       int pthread_mutexattr_getpshared(const pthread_mutexattr_t
           *restrict _a_t_t_r, int *restrict _p_s_h_a_r_e_d);
       int pthread_mutexattr_setpshared(pthread_mutexattr_t *_a_t_t_r,
           int _p_s_h_a_r_e_d);

DDEESSCCRRIIPPTTIIOONN
       The _p_t_h_r_e_a_d___m_u_t_e_x_a_t_t_r___g_e_t_p_s_h_a_r_e_d() function shall obtain the value of
       the _p_r_o_c_e_s_s_-_s_h_a_r_e_d attribute from the attributes object referenced by
       _a_t_t_r.

       The _p_t_h_r_e_a_d___m_u_t_e_x_a_t_t_r___s_e_t_p_s_h_a_r_e_d() function shall set the _p_r_o_c_e_s_s_-
       _s_h_a_r_e_d attribute in an initialized attributes object referenced by
       _a_t_t_r.

       The _p_r_o_c_e_s_s_-_s_h_a_r_e_d attribute is set to PTHREAD_PROCESS_SHARED to permit
       a mutex to be operated upon by any thread that has access to the memory
       where the mutex is allocated, even if the mutex is allocated in memory
       that is shared by multiple processes. See _S_e_c_t_i_o_n _2_._9_._9,
       _S_y_n_c_h_r_o_n_i_z_a_t_i_o_n _O_b_j_e_c_t _C_o_p_i_e_s _a_n_d _A_l_t_e_r_n_a_t_i_v_e _M_a_p_p_i_n_g_s for further
       requirements. The default value of the attribute shall be
       PTHREAD_PROCESS_PRIVATE.

       The behavior is undefined if the value specified by the _a_t_t_r argument
       to _p_t_h_r_e_a_d___m_u_t_e_x_a_t_t_r___g_e_t_p_s_h_a_r_e_d() or _p_t_h_r_e_a_d___m_u_t_e_x_a_t_t_r___s_e_t_p_s_h_a_r_e_d()
       does not refer to an initialized mutex attributes object.

RREETTUURRNN VVAALLUUEE
       Upon successful completion, _p_t_h_r_e_a_d___m_u_t_e_x_a_t_t_r___s_e_t_p_s_h_a_r_e_d() shall return
       zero; otherwise, an error number shall be returned to indicate the
       error.

       Upon successful completion, _p_t_h_r_e_a_d___m_u_t_e_x_a_t_t_r___g_e_t_p_s_h_a_r_e_d() shall return
       zero and store the value of the _p_r_o_c_e_s_s_-_s_h_a_r_e_d attribute of _a_t_t_r into
       the object referenced by the _p_s_h_a_r_e_d parameter. Otherwise, an error
       number shall be returned to indicate the error.

EERRRROORRSS
       The _p_t_h_r_e_a_d___m_u_t_e_x_a_t_t_r___s_e_t_p_s_h_a_r_e_d() function may fail if:

       EEIINNVVAALL The new value specified for the attribute is outside the range
              of legal values for that attribute.

       These functions shall not return an error code of [[EEIINNTTRR]].

       _T_h_e _f_o_l_l_o_w_i_n_g _s_e_c_t_i_o_n_s _a_r_e _i_n_f_o_r_m_a_t_i_v_e_.

EEXXAAMMPPLLEESS
       None.

AAPPPPLLIICCAATTIIOONN UUSSAAGGEE
       None.

RRAATTIIOONNAALLEE
       If an implementation detects that the value specified by the _a_t_t_r
       argument to _p_t_h_r_e_a_d___m_u_t_e_x_a_t_t_r___g_e_t_p_s_h_a_r_e_d() or
       _p_t_h_r_e_a_d___m_u_t_e_x_a_t_t_r___s_e_t_p_s_h_a_r_e_d() does not refer to an initialized mutex
       attributes object, it is recommended that the function should fail and
       report an [[EEIINNVVAALL]] error.

FFUUTTUURREE DDIIRREECCTTIIOONNSS
       None.

SSEEEE AALLSSOO
       _p_t_h_r_e_a_d___c_o_n_d___d_e_s_t_r_o_y(), _p_t_h_r_e_a_d___c_r_e_a_t_e(), _p_t_h_r_e_a_d___m_u_t_e_x___d_e_s_t_r_o_y(),
       _p_t_h_r_e_a_d___m_u_t_e_x_a_t_t_r___d_e_s_t_r_o_y()

       The Base Definitions volume of POSIX.1-2017, <<pptthhrreeaadd..hh>>

CCOOPPYYRRIIGGHHTT
       Portions of this text are reprinted and reproduced in electronic form
       from IEEE Std 1003.1-2017, Standard for Information Technology --
       Portable Operating System Interface (POSIX), The Open Group Base
       Specifications Issue 7, 2018 Edition, Copyright (C) 2018 by the
       Institute of Electrical and Electronics Engineers, Inc and The Open
       Group.  In the event of any discrepancy between this version and the
       original IEEE and The Open Group Standard, the original IEEE and The
       Open Group Standard is the referee document. The original Standard can
       be obtained online at http://www.opengroup.org/unix/online.html .

       Any typographical or formatting errors that appear in this page are
       most likely to have been introduced during the conversion of the source
       files to man page format. To report such errors, see
       https://www.kernel.org/doc/man-pages/reporting_bugs.html .



IEEE/The Open Group                  2017      PTHREAD_MUTEXATTR_GETPSHARED(3)
