PTHREAD_ATTR_GETDETACHSTATE(P3O)SIX Programmer's ManPuTaHlREAD_ATTR_GETDETACHSTATE(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_attr_getdetachstate, pthread_attr_setdetachstate -- get and set
       the detachstate attribute

SSYYNNOOPPSSIISS
       #include <pthread.h>

       int pthread_attr_getdetachstate(const pthread_attr_t *_a_t_t_r,
           int *_d_e_t_a_c_h_s_t_a_t_e);
       int pthread_attr_setdetachstate(pthread_attr_t *_a_t_t_r, int _d_e_t_a_c_h_s_t_a_t_e);

DDEESSCCRRIIPPTTIIOONN
       The _d_e_t_a_c_h_s_t_a_t_e attribute controls whether the thread is created in a
       detached state.  If the thread is created detached, then use of the ID
       of the newly created thread by the _p_t_h_r_e_a_d___d_e_t_a_c_h() or _p_t_h_r_e_a_d___j_o_i_n()
       function is an error.

       The _p_t_h_r_e_a_d___a_t_t_r___g_e_t_d_e_t_a_c_h_s_t_a_t_e() and _p_t_h_r_e_a_d___a_t_t_r___s_e_t_d_e_t_a_c_h_s_t_a_t_e()
       functions, respectively, shall get and set the _d_e_t_a_c_h_s_t_a_t_e attribute in
       the _a_t_t_r object.

       For _p_t_h_r_e_a_d___a_t_t_r___g_e_t_d_e_t_a_c_h_s_t_a_t_e(), _d_e_t_a_c_h_s_t_a_t_e shall be set to either
       PTHREAD_CREATE_DETACHED or PTHREAD_CREATE_JOINABLE.

       For _p_t_h_r_e_a_d___a_t_t_r___s_e_t_d_e_t_a_c_h_s_t_a_t_e(), the application shall set
       _d_e_t_a_c_h_s_t_a_t_e to either PTHREAD_CREATE_DETACHED or
       PTHREAD_CREATE_JOINABLE.

       A value of PTHREAD_CREATE_DETACHED shall cause all threads created with
       _a_t_t_r to be in the detached state, whereas using a value of
       PTHREAD_CREATE_JOINABLE shall cause all threads created with _a_t_t_r to be
       in the joinable state. The default value of the _d_e_t_a_c_h_s_t_a_t_e attribute
       shall be PTHREAD_CREATE_JOINABLE.

       The behavior is undefined if the value specified by the _a_t_t_r argument
       to _p_t_h_r_e_a_d___a_t_t_r___g_e_t_d_e_t_a_c_h_s_t_a_t_e() or _p_t_h_r_e_a_d___a_t_t_r___s_e_t_d_e_t_a_c_h_s_t_a_t_e() does
       not refer to an initialized thread attributes object.

RREETTUURRNN VVAALLUUEE
       Upon successful completion, _p_t_h_r_e_a_d___a_t_t_r___g_e_t_d_e_t_a_c_h_s_t_a_t_e() and
       _p_t_h_r_e_a_d___a_t_t_r___s_e_t_d_e_t_a_c_h_s_t_a_t_e() shall return a value of 0; otherwise, an
       error number shall be returned to indicate the error.

       The _p_t_h_r_e_a_d___a_t_t_r___g_e_t_d_e_t_a_c_h_s_t_a_t_e() function stores the value of the
       _d_e_t_a_c_h_s_t_a_t_e attribute in _d_e_t_a_c_h_s_t_a_t_e if successful.

EERRRROORRSS
       The _p_t_h_r_e_a_d___a_t_t_r___s_e_t_d_e_t_a_c_h_s_t_a_t_e() function shall fail if:

       EEIINNVVAALL The value of _d_e_t_a_c_h_s_t_a_t_e was not valid

       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
   RReettrriieevviinngg tthhee ddeettaacchhssttaattee AAttttrriibbuuttee
       This example shows how to obtain the _d_e_t_a_c_h_s_t_a_t_e attribute of a thread
       attribute object.


           #include <pthread.h>

           pthread_attr_t thread_attr;
           int            detachstate;
           int            rc;

           /* code initializing thread_attr */
           ...

           rc = pthread_attr_getdetachstate (&thread_attr, &detachstate);
           if (rc!=0) {
               /* handle error */
               ...
           }
           else {
               /* legal values for detachstate are:
                * PTHREAD_CREATE_DETACHED or PTHREAD_CREATE_JOINABLE
                */
                ...
           }

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___a_t_t_r___g_e_t_d_e_t_a_c_h_s_t_a_t_e() or
       _p_t_h_r_e_a_d___a_t_t_r___s_e_t_d_e_t_a_c_h_s_t_a_t_e() does not refer to an initialized thread
       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___a_t_t_r___d_e_s_t_r_o_y(), _p_t_h_r_e_a_d___a_t_t_r___g_e_t_s_t_a_c_k_s_i_z_e(), _p_t_h_r_e_a_d___c_r_e_a_t_e()

       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_ATTR_GETDETACHSTATE(3)
