NAME
pthread_attr_getdetachstate
pthread_attr_setdetachstate —
get and set the detachstate attribute
SYNOPSIS
int pthread_attr_getdetachstate(const pthread_attr_t *attr,
int *detachstate);
int pthread_attr_setdetachstate(pthread_attr_t *attr, int detachstate);
DESCRIPTION
The detachstate 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 pthread_detach(3) or pthread_join(3) function is an error.
The pthread_attr_getdetachstate () and
pthread_attr_setdetachstate () functions, respectively,
shall get and set the detachstate attribute in the
attr object.
For pthread_attr_getdetachstate (),
detachstate shall be set to either PTHREAD_CREATE_DETACHED
or PTHREAD_CREATE_JOINABLE.
For pthread_attr_setdetachstate (), the application shall set detachstate to either PTHREAD_CREATE_DETACHED or PTHREAD_CREATE_JOINABLE.
A value of PTHREAD_CREATE_DETACHED shall cause all threads created with attr to be in the detached state, whereas using a value of PTHREAD_CREATE_JOINABLE shall cause all threads created with attr to be in the joinable state. The default value of the detachstate attribute shall be PTHREAD_CREATE_JOINABLE.
RETURN VALUE
Upon successful completion,
pthread_attr_getdetachstate () and
pthread_attr_setdetachstate () shall return a value of 0;
otherwise, an error number shall be returned to indicate the error.
The pthread_attr_getdetachstate ()
function stores the value of the detachstate attribute in
detachstate if successful.
ERRORS
The pthread_attr_setdetachstate () function shall fail if:
- [EINVAL]
- The value of detachstate was not valid
These functions shall not return an error code of [EINTR].
EXAMPLES
None.
APPLICATION USAGE
None.
RATIONALE
None.
FUTURE DIRECTIONS
None.
SEE ALSO
pthread_attr_destroy(3) , pthread_attr_getstackaddr(3) , pthread_attr_getstacksize(3) , pthread_create(3) , the Base Definitions volume of IEEE Std 1003.1-2001 (“POSIX.1”), <pthread.h>
CHANGE HISTORY
First released in Issue 5. Included for alignment with the POSIX Threads Extension.
Issue 6
The pthread_attr_setdetachstate () and
pthread_attr_getdetachstate () functions are marked
as part of the Threads option.
The DESCRIPTION is updated to avoid use of the term "must" for application requirements.
End of informative text. footer end