devdocs/c/thread%2Fthrd_create.html


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29

    <h1 id="firstHeading" class="firstHeading">thrd_create</h1>            <table class="t-dcl-begin"> <tr class="t-dsc-header"> <th> Defined in header <code>&lt;threads.h&gt;</code> </th> <th> </th> <th> </th> </tr> <tr class="t-dcl t-since-c11"> <td> <pre data-language="c">int thrd_create( thrd_t *thr, thrd_start_t func, void *arg );</pre>
</td> <td class="t-dcl-nopad"> </td> <td> <span class="t-mark-rev t-since-c11">(since C11)</span> </td> </tr>  </table> <p>Creates a new thread executing the function <code>func</code>. The function is invoked as <code>func(arg)</code>.</p>
<p>If successful, the object pointed to by <code>thr</code> is set to the identifier of the new thread.</p>
<p>The completion of this function <i>synchronizes-with</i> the beginning of the thread.</p>
<h3 id="Parameters"> Parameters</h3> <table class="t-par-begin"> <tr class="t-par"> <td> thr </td> <td> - </td> <td> pointer to memory location to put the identifier of the new thread </td>
</tr> <tr class="t-par"> <td> func </td> <td> - </td> <td> function to execute </td>
</tr> <tr class="t-par"> <td> arg </td> <td> - </td> <td> argument to pass to the function </td>
</tr>
</table> <h3 id="Return_value"> Return value</h3> <p><code><a href="thrd_errors" title="c/thread/thrd errors">thrd_success</a></code> if the creation of the new thread was successful. Otherwise returns <code><a href="thrd_errors" title="c/thread/thrd errors">thrd_nomem</a></code> if there was insufficient amount of memory or <code><a href="thrd_errors" title="c/thread/thrd errors">thrd_error</a></code> if another error occurred.</p>
<h3 id="Notes"> Notes</h3> <p>The thread identifiers may be reused for new threads once the thread has finished and joined or detached.</p>
<p>The type <code><a href="../thread" title="c/thread">thrd_start_t</a></code> is a typedef of <code>int(*)(void*)</code>, which differs from the POSIX equivalent <code>void*(*)(void*)</code></p>
<p>All thread-specific storage values (see <code><a href="tss_create" title="c/thread/tss create">tss_create</a></code>) are initialized to <code><a href="../types/null" title="c/types/NULL">NULL</a></code>.</p>
<p>Return from the function <code>func</code> is equivalent to calling <code><a href="thrd_exit" title="c/thread/thrd exit">thrd_exit</a></code> with the argument equal to the return value of <code>func</code>.</p>
<h3 id="References"> References</h3>  <ul>
<li> C17 standard (ISO/IEC 9899:2018): </li>
<ul><li> 7.26.5.1 The thrd_create function (p: 279) </li></ul>
<li> C11 standard (ISO/IEC 9899:2011): </li>
<ul><li> 7.26.5.1 The thrd_create function (p: 383) </li></ul>
</ul>       <h3 id="See_also"> See also</h3> <table class="t-dsc-begin"> <tr class="t-dsc"> <td> <div><a href="thrd_detach" title="c/thread/thrd detach"> <span class="t-lines"><span>thrd_detach</span></span></a></div>
<div><span class="t-lines"><span><span class="t-mark-rev t-since-c11">(C11)</span></span></span></div> </td> <td> detaches a thread <br> <span class="t-mark">(function)</span>  </td>
</tr> <tr class="t-dsc"> <td> <div><a href="thrd_join" title="c/thread/thrd join"> <span class="t-lines"><span>thrd_join</span></span></a></div>
<div><span class="t-lines"><span><span class="t-mark-rev t-since-c11">(C11)</span></span></span></div> </td> <td> blocks until a thread terminates <br> <span class="t-mark">(function)</span>  </td>
</tr> <tr class="t-dsc"> <td colspan="2"> <span><a href="https://en.cppreference.com/w/cpp/thread/thread/thread" title="cpp/thread/thread/thread">C++ documentation</a></span> for <code>thread</code> </td>
</tr> </table>           <div class="_attribution">
  <p class="_attribution-p">
    &copy; cppreference.com<br>Licensed under the Creative Commons Attribution-ShareAlike Unported License v3.0.<br>
    <a href="https://en.cppreference.com/w/c/thread/thrd_create" class="_attribution-link">https://en.cppreference.com/w/c/thread/thrd_create</a>
  </p>
</div>