1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2<html xml:lang="en-US" lang="en-US" xmlns="http://www.w3.org/1999/xhtml">
3  <head>
4    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
5    <meta http-equiv="Content-Style-Type" content="text/css" />
6    <link rel="stylesheet" href="../../../css/manpage.css" type="text/css" />
7<title>StartUsingAutoStack</title>
8  </head>
9  <body>
10<h1><CODE><a href="../../../nn/Overview.html">nn</a>::<a href="../../../nn/os/Overview.html">os</a>::<a href="../../../nn/os/Thread/Overview.html">Thread</a>::StartUsingAutoStack</CODE> Member Function</h1>
11<h2>Syntax</h2>
12    <div class="section">
13      <pre class="definition">#include &lt;nn/os.h&gt;
14
15template &lt;typename T, typename U&gt;
16void StartUsingAutoStack(
17     void(*)(T) f,
18     U param,
19     size_t stackSize,
20     <a href="../../../nn_types/s32.html">s32</a> priority = DEFAULT_THREAD_PRIORITY,
21     <a href="../../../nn_types/s32.html">s32</a> coreNo = CORE_NO_USE_PROCESS_VALUE
22);
23</pre>
24    </div>
25<h2>Template Arguments</h2>
26    <div class="section">
27      <table class="arguments">
28        <thead>
29          <tr>
30<th>Name</th>
31<td>Description</td>
32          </tr>
33        </thead>
34        <tr>
35<th><CODE>T</CODE></th>
36<td>Data type of argument(s) of the function to run (this type must be copyable).</td>
37        </tr>
38        <tr>
39<th>U</th>
40<td>A type that can be converted to <SPAN class="argument">T</SPAN>.</td>
41        </tr> </table>
42    </div>
43<h2>Arguments</h2>
44    <div class="section">
45      <table class="arguments">
46        <thead>
47          <tr>
48            <td width="15" />
49<th>Name</th>
50<td>Description</td>
51          </tr>
52        </thead>
53        <tr>
54<td>in</td>
55<th>f</th>
56<td>Pointer to the function to begin running.</td>
57        </tr>
58        <tr>
59<td>in</td>
60<th><CODE>param</CODE></th>
61<td>Argument to pass to the function that begins execution.</td>
62        </tr>
63        <tr>
64<td>in</td>
65<th>stackSize</th>
66<td>The stack size.</td>
67        </tr>
68        <tr>
69<td>in</td>
70<th>priority</th>
71<td>Priority of the thread.</td>
72        </tr>
73        <tr>
74<td>in</td>
75<th>coreNo</th>
76<td>Preferred processor for the thread.</td>
77        </tr> </table>
78    </div>
79<h2>Return Values</h2>
80    <div class="section">
81None.
82               </div>
83<h2>Description</h2>
84    <div class="section">
85<p>Initializes and runs a thread.</p><p>Allocates a stack of the specified size using <CODE><a href="../../../nn/os/AutoStackManager/Overview.html">AutoStackManager</a></CODE> and automatically destroys the stack when the thread is destroyed.</p></div>
86<h2>Revision History</h2>
87    <div class="section">
88      <dl class="history">
89        <dt>2011/09/01</dt>
90<dd>Deleted the note about specifying a preferred processor.<br />
91        </dd>
92        <dt>2011/06/22</dt>
93<dd>Added a note about specifying a preferred processor.<br />
94        </dd>
95        <dt>2010/03/28</dt>
96<dd>Clarified restrictions on <SPAN class="argument">stackSize</SPAN> argument.<br />
97        </dd>
98        <dt>2010/01/07</dt>
99<dd>Initial version.<br />
100        </dd>
101      </dl>
102    </div>
103  <hr><p>CONFIDENTIAL</p></body>
104</html>
105