devdocs/c/thread%2Fmtx_lock.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

    <h1 id="firstHeading" class="firstHeading">mtx_lock</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 mtx_lock( mtx_t* mutex );</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 mutex pointed to by <code>mutex</code> is locked.</p>
<p>The behavior is undefined if the current thread has already locked the mutex and the mutex is not recursive.</p>
<p>Prior calls to <code><a href="mtx_unlock" title="c/thread/mtx unlock">mtx_unlock</a></code> on the same mutex <i>synchronize-with</i> this operation, and all lock/unlock operations on any given mutex form a single total order (similar to the modification order of an atomic)</p>
<h3 id="Parameters"> Parameters</h3> <table class="t-par-begin"> <tr class="t-par"> <td> mutex </td> <td> - </td> <td> pointer to the mutex to lock </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.4.3 The mtx_lock function (p: 278) </li></ul>
<li> C11 standard (ISO/IEC 9899:2011): </li>
<ul><li> 7.26.4.3 The mtx_lock function (p: 381) </li></ul>
</ul>       <h3 id="See_also"> See also</h3> <table class="t-dsc-begin"> <tr class="t-dsc"> <td> <div><a href="mtx_timedlock" title="c/thread/mtx timedlock"> <span class="t-lines"><span>mtx_timedlock</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 locks a mutex or times out <br> <span class="t-mark">(function)</span>  </td>
</tr> <tr class="t-dsc"> <td> <div><a href="mtx_trylock" title="c/thread/mtx trylock"> <span class="t-lines"><span>mtx_trylock</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> locks a mutex or returns without blocking if already locked <br> <span class="t-mark">(function)</span>  </td>
</tr> <tr class="t-dsc"> <td> <div><a href="mtx_unlock" title="c/thread/mtx unlock"> <span class="t-lines"><span>mtx_unlock</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> unlocks a mutex <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/mutex/lock" title="cpp/thread/mutex/lock">C++ documentation</a></span> for <code>mutex::lock</code> </td>
</tr> <tr class="t-dsc"> <td colspan="2"> <span><a href="https://en.cppreference.com/w/cpp/thread/timed_mutex/lock" title="cpp/thread/timed mutex/lock">C++ documentation</a></span> for <code>timed_mutex::lock</code> </td>
</tr> <tr class="t-dsc"> <td colspan="2"> <span><a href="https://en.cppreference.com/w/cpp/thread/recursive_mutex/lock" title="cpp/thread/recursive mutex/lock">C++ documentation</a></span> for <code>recursive_mutex::lock</code> </td>
</tr> <tr class="t-dsc"> <td colspan="2"> <span><a href="https://en.cppreference.com/w/cpp/thread/recursive_timed_mutex/lock" title="cpp/thread/recursive timed mutex/lock">C++ documentation</a></span> for <code>recursive_timed_mutex::lock</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/mtx_lock" class="_attribution-link">https://en.cppreference.com/w/c/thread/mtx_lock</a>
  </p>
</div>