Files
oldlinux-files/Ref-docs/POSIX/susv3/functions/pthread_attr_getstacksize.html
2024-02-19 00:21:47 -05:00

142 lines
5.0 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_getstacksize</title>
</head>
<body bgcolor="white">
<script type="text/javascript" language="JavaScript" src="../jscript/codes.js">
</script>
<basefont size="3"> <a name="pthread_attr_getstacksize"></a> <a name="tag_03_496"></a><!-- pthread_attr_getstacksize -->
<!--header start-->
<center><font size="2">The Open Group Base Specifications Issue 6<br>
IEEE Std 1003.1-2001<br>
Copyright &copy; 2001 The IEEE and The Open Group, All Rights reserved.</font></center>
<!--header end-->
<hr size="2" noshade>
<h4><a name="tag_03_496_01"></a>NAME</h4>
<blockquote>pthread_attr_getstacksize, pthread_attr_setstacksize - get and set the stacksize attribute</blockquote>
<h4><a name="tag_03_496_02"></a>SYNOPSIS</h4>
<blockquote class="synopsis">
<div class="box"><code><tt><sup>[<a href="javascript:open_code('THR TSA')">THR TSA</a>]</sup> <img src="../images/opt-start.gif" alt=
"[Option Start]" border="0"> #include &lt;<a href="../basedefs/pthread.h.html">pthread.h</a>&gt;<br>
<br>
int pthread_attr_getstacksize(const pthread_attr_t *restrict</tt> <i>attr</i><tt>,<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; size_t *restrict</tt> <i>stacksize</i><tt>);<br>
int pthread_attr_setstacksize(pthread_attr_t *</tt><i>attr</i><tt>, size_t</tt> <i>stacksize</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_496_03"></a>DESCRIPTION</h4>
<blockquote>
<p>The <i>pthread_attr_getstacksize</i>() and <i>pthread_attr_setstacksize</i>() functions, respectively, shall get and set the
thread creation <i>stacksize</i> attribute in the <i>attr</i> object.</p>
<p>The <i>stacksize</i> attribute shall define the minimum stack size (in bytes) allocated for the created threads stack.</p>
</blockquote>
<h4><a name="tag_03_496_04"></a>RETURN VALUE</h4>
<blockquote>
<p>Upon successful completion, <i>pthread_attr_getstacksize</i>() and <i>pthread_attr_setstacksize</i>() shall return a value of 0;
otherwise, an error number shall be returned to indicate the error.</p>
<p>The <i>pthread_attr_getstacksize</i>() function stores the <i>stacksize</i> attribute value in <i>stacksize</i> if
successful.</p>
</blockquote>
<h4><a name="tag_03_496_05"></a>ERRORS</h4>
<blockquote>
<p>The <i>pthread_attr_setstacksize</i>() function shall fail if:</p>
<dl compact>
<dt>[EINVAL]</dt>
<dd>The value of <i>stacksize</i> is less than {PTHREAD_STACK_MIN} or exceeds a system-imposed limit.</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_496_06"></a>EXAMPLES</h4>
<blockquote>
<p>None.</p>
</blockquote>
<h4><a name="tag_03_496_07"></a>APPLICATION USAGE</h4>
<blockquote>
<p>None.</p>
</blockquote>
<h4><a name="tag_03_496_08"></a>RATIONALE</h4>
<blockquote>
<p>None.</p>
</blockquote>
<h4><a name="tag_03_496_09"></a>FUTURE DIRECTIONS</h4>
<blockquote>
<p>None.</p>
</blockquote>
<h4><a name="tag_03_496_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_getdetachstate.html"><i>pthread_attr_getdetachstate</i>()</a> , <a href=
"pthread_create.html"><i>pthread_create</i>()</a> , the Base Definitions volume of IEEE&nbsp;Std&nbsp;1003.1-2001, <a href=
"../basedefs/limits.h.html"><i>&lt;limits.h&gt;</i></a>, <a href="../basedefs/pthread.h.html"><i>&lt;pthread.h&gt;</i></a></p>
</blockquote>
<h4><a name="tag_03_496_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_496_12"></a>Issue 6</h4>
<blockquote>
<p>The <i>pthread_attr_getstacksize</i>() and <i>pthread_attr_setstacksize</i>() functions are marked as part of the Threads and
Thread Stack Address Attribute options.</p>
<p>The <b>restrict</b> keyword is added to the <i>pthread_attr_getstacksize</i>() prototype for alignment with the
ISO/IEC&nbsp;9899:1999 standard.</p>
</blockquote>
<div class="box"><em>End of informative text.</em></div>
<hr>
<hr size="2" noshade>
<center><font size="2"><!--footer start-->
UNIX &reg; is a registered Trademark of The Open Group.<br>
POSIX &reg; 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>