153 lines
5.6 KiB
HTML
153 lines
5.6 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<html>
|
|
<head>
|
|
<meta name="generator" content="HTML Tidy, see www.w3.org">
|
|
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
|
|
<link type="text/css" rel="stylesheet" href="style.css"><!-- Generated by The Open Group's rhtm tool v1.2.1 -->
|
|
<!-- Copyright (c) 2001 The Open Group, All Rights Reserved -->
|
|
<title>pthread_attr_getdetachstate</title>
|
|
</head>
|
|
<body bgcolor="white">
|
|
<script type="text/javascript" language="JavaScript" src="../jscript/codes.js">
|
|
</script>
|
|
|
|
<basefont size="3"> <a name="pthread_attr_getdetachstate"></a> <a name="tag_03_488"></a><!-- pthread_attr_getdetachstate -->
|
|
<!--header start-->
|
|
<center><font size="2">The Open Group Base Specifications Issue 6<br>
|
|
IEEE Std 1003.1-2001<br>
|
|
Copyright © 2001 The IEEE and The Open Group, All Rights reserved.</font></center>
|
|
|
|
<!--header end-->
|
|
<hr size="2" noshade>
|
|
<h4><a name="tag_03_488_01"></a>NAME</h4>
|
|
|
|
<blockquote>pthread_attr_getdetachstate, pthread_attr_setdetachstate - get and set the detachstate attribute</blockquote>
|
|
|
|
<h4><a name="tag_03_488_02"></a>SYNOPSIS</h4>
|
|
|
|
<blockquote class="synopsis">
|
|
<div class="box"><code><tt><sup>[<a href="javascript:open_code('THR')">THR</a>]</sup> <img src="../images/opt-start.gif" alt=
|
|
"[Option Start]" border="0"> #include <<a href="../basedefs/pthread.h.html">pthread.h</a>><br>
|
|
<br>
|
|
int pthread_attr_getdetachstate(const pthread_attr_t *</tt><i>attr</i><tt>,<br>
|
|
int *</tt><i>detachstate</i><tt>);<br>
|
|
int pthread_attr_setdetachstate(pthread_attr_t *</tt><i>attr</i><tt>, int</tt> <i>detachstate</i><tt>); <img src=
|
|
"../images/opt-end.gif" alt="[Option End]" border="0"></tt></code></div>
|
|
|
|
<tt><br>
|
|
</tt></blockquote>
|
|
|
|
<h4><a name="tag_03_488_03"></a>DESCRIPTION</h4>
|
|
|
|
<blockquote>
|
|
<p>The <i>detachstate</i> 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 <a href="../functions/pthread_detach.html"><i>pthread_detach</i>()</a> or <a
|
|
href="../functions/pthread_join.html"><i>pthread_join</i>()</a> function is an error.</p>
|
|
|
|
<p>The <i>pthread_attr_getdetachstate</i>() and <i>pthread_attr_setdetachstate</i>() functions, respectively, shall get and set the
|
|
<i>detachstate</i> attribute in the <i>attr</i> object.</p>
|
|
|
|
<p>For <i>pthread_attr_getdetachstate</i>(), <i>detachstate</i> shall be set to either PTHREAD_CREATE_DETACHED or
|
|
PTHREAD_CREATE_JOINABLE.</p>
|
|
|
|
<p>For <i>pthread_attr_setdetachstate</i>(), the application shall set <i>detachstate</i> to either PTHREAD_CREATE_DETACHED or
|
|
PTHREAD_CREATE_JOINABLE.</p>
|
|
|
|
<p>A value of PTHREAD_CREATE_DETACHED shall cause all threads created with <i>attr</i> to be in the detached state, whereas using a
|
|
value of PTHREAD_CREATE_JOINABLE shall cause all threads created with <i>attr</i> to be in the joinable state. The default value of
|
|
the <i>detachstate</i> attribute shall be PTHREAD_CREATE_JOINABLE.</p>
|
|
</blockquote>
|
|
|
|
<h4><a name="tag_03_488_04"></a>RETURN VALUE</h4>
|
|
|
|
<blockquote>
|
|
<p>Upon successful completion, <i>pthread_attr_getdetachstate</i>() and <i>pthread_attr_setdetachstate</i>() shall return a value
|
|
of 0; otherwise, an error number shall be returned to indicate the error.</p>
|
|
|
|
<p>The <i>pthread_attr_getdetachstate</i>() function stores the value of the <i>detachstate</i> attribute in <i>detachstate</i> if
|
|
successful.</p>
|
|
</blockquote>
|
|
|
|
<h4><a name="tag_03_488_05"></a>ERRORS</h4>
|
|
|
|
<blockquote>
|
|
<p>The <i>pthread_attr_setdetachstate</i>() function shall fail if:</p>
|
|
|
|
<dl compact>
|
|
<dt>[EINVAL]</dt>
|
|
|
|
<dd>The value of <i>detachstate</i> was not valid</dd>
|
|
</dl>
|
|
|
|
<p>These functions shall not return an error code of [EINTR].</p>
|
|
</blockquote>
|
|
|
|
<hr>
|
|
<div class="box"><em>The following sections are informative.</em></div>
|
|
|
|
<h4><a name="tag_03_488_06"></a>EXAMPLES</h4>
|
|
|
|
<blockquote>
|
|
<p>None.</p>
|
|
</blockquote>
|
|
|
|
<h4><a name="tag_03_488_07"></a>APPLICATION USAGE</h4>
|
|
|
|
<blockquote>
|
|
<p>None.</p>
|
|
</blockquote>
|
|
|
|
<h4><a name="tag_03_488_08"></a>RATIONALE</h4>
|
|
|
|
<blockquote>
|
|
<p>None.</p>
|
|
</blockquote>
|
|
|
|
<h4><a name="tag_03_488_09"></a>FUTURE DIRECTIONS</h4>
|
|
|
|
<blockquote>
|
|
<p>None.</p>
|
|
</blockquote>
|
|
|
|
<h4><a name="tag_03_488_10"></a>SEE ALSO</h4>
|
|
|
|
<blockquote>
|
|
<p><a href="pthread_attr_destroy.html"><i>pthread_attr_destroy</i>()</a> , <a href=
|
|
"pthread_attr_getstackaddr.html"><i>pthread_attr_getstackaddr</i>()</a> , <a href=
|
|
"pthread_attr_getstacksize.html"><i>pthread_attr_getstacksize</i>()</a> , <a href="pthread_create.html"><i>pthread_create</i>()</a>
|
|
, the Base Definitions volume of IEEE Std 1003.1-2001, <a href=
|
|
"../basedefs/pthread.h.html"><i><pthread.h></i></a></p>
|
|
</blockquote>
|
|
|
|
<h4><a name="tag_03_488_11"></a>CHANGE HISTORY</h4>
|
|
|
|
<blockquote>
|
|
<p>First released in Issue 5. Included for alignment with the POSIX Threads Extension.</p>
|
|
</blockquote>
|
|
|
|
<h4><a name="tag_03_488_12"></a>Issue 6</h4>
|
|
|
|
<blockquote>
|
|
<p>The <i>pthread_attr_setdetachstate</i>() and <i>pthread_attr_getdetachstate</i>() functions are marked as part of the Threads
|
|
option.</p>
|
|
|
|
<p>The DESCRIPTION is updated to avoid use of the term "must" for application requirements.</p>
|
|
</blockquote>
|
|
|
|
<div class="box"><em>End of informative text.</em></div>
|
|
|
|
<hr>
|
|
<hr size="2" noshade>
|
|
<center><font size="2"><!--footer start-->
|
|
UNIX ® is a registered Trademark of The Open Group.<br>
|
|
POSIX ® is a registered Trademark of The IEEE.<br>
|
|
[ <a href="../mindex.html">Main Index</a> | <a href="../basedefs/contents.html">XBD</a> | <a href=
|
|
"../utilities/contents.html">XCU</a> | <a href="../functions/contents.html">XSH</a> | <a href="../xrat/contents.html">XRAT</a>
|
|
]</font></center>
|
|
|
|
<!--footer end-->
|
|
<hr size="2" noshade>
|
|
</body>
|
|
</html>
|
|
|