summaryrefslogtreecommitdiff
path: root/devdocs/c/thread%2Fthrd_join.html
blob: e4764b636aba18de5d750c50202d89c15fc3e7df (plain)
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
    <h1 id="firstHeading" class="firstHeading">thrd_join</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_join( thrd_t thr, int *res );</pre>
</td> <td class="t-dcl-nopad"> </td> <td> <span class="t-mark-rev t-since-c11">(since C11)</span> </td> </tr>  </table> <p>Blocks the current thread until the thread identified by <code>thr</code> finishes execution.</p>
<p>If <code>res</code> is not a null pointer, the result code of the thread is put to the location pointed to by <code>res</code>.</p>
<p>The termination of the thread <i>synchronizes-with</i> the completion of this function.</p>
<p>The behavior is undefined if the thread was previously detached or joined by another thread.</p>
<h3 id="Parameters"> Parameters</h3> <table class="t-par-begin"> <tr class="t-par"> <td> thr </td> <td> - </td> <td> identifier of the thread to join </td>
</tr> <tr class="t-par"> <td> res </td> <td> - </td> <td> location to put the result code to </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 successful, <code><a href="thrd_errors" title="c/thread/thrd errors">thrd_error</a></code> otherwise.</p>
<h3 id="References"> References</h3>  <ul>
<li> C17 standard (ISO/IEC 9899:2018): </li>
<ul><li> 7.26.5.6 The thrd_join function (p: 280-281) </li></ul>
<li> C11 standard (ISO/IEC 9899:2011): </li>
<ul><li> 7.26.5.6 The thrd_join function (p: 384-385) </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_exit" title="c/thread/thrd exit"> <span class="t-lines"><span>thrd_exit</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> terminates the calling thread <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/join" title="cpp/thread/thread/join">C++ documentation</a></span> for <code>join</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_join" class="_attribution-link">https://en.cppreference.com/w/c/thread/thrd_join</a>
  </p>
</div>