diff options
Diffstat (limited to 'devdocs/c/thread%2Fmtx_init.html')
| -rw-r--r-- | devdocs/c/thread%2Fmtx_init.html | 31 |
1 files changed, 31 insertions, 0 deletions
diff --git a/devdocs/c/thread%2Fmtx_init.html b/devdocs/c/thread%2Fmtx_init.html new file mode 100644 index 00000000..b500c70e --- /dev/null +++ b/devdocs/c/thread%2Fmtx_init.html @@ -0,0 +1,31 @@ + <h1 id="firstHeading" class="firstHeading">mtx_init</h1> <table class="t-dcl-begin"> <tr class="t-dsc-header"> <th> Defined in header <code><threads.h></code> </th> <th> </th> <th> </th> </tr> <tr class="t-dcl t-since-c11"> <td> <pre data-language="c">int mtx_init( mtx_t* mutex, int type );</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 mutex object with <code>type</code>. The object pointed to by <code>mutex</code> is set to an identifier of the newly created mutex.</p> +<p><code>type</code> must have one of the following values:</p> +<ul> +<li> +<code><a href="mtx_types" title="c/thread/mtx types">mtx_plain</a></code> - a simple, non-recursive mutex is created. </li> +<li> +<code><a href="mtx_types" title="c/thread/mtx types">mtx_timed</a></code> - a non-recursive mutex, that supports timeout, is created. </li> +<li> +<code><a href="http://en.cppreference.com/w/c/thread/mtx_types"><span class="kw1017">mtx_plain</span></a> <span class="sy3">|</span> <a href="http://en.cppreference.com/w/c/thread/mtx_types"><span class="kw1018">mtx_recursive</span></a></code> - a recursive mutex is created. </li> +<li> +<code><a href="http://en.cppreference.com/w/c/thread/mtx_types"><span class="kw1019">mtx_timed</span></a> <span class="sy3">|</span> <a href="http://en.cppreference.com/w/c/thread/mtx_types"><span class="kw1018">mtx_recursive</span></a></code> - a recursive mutex, that supports timeout, is created. </li> +</ul> <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 initialize </td> +</tr> <tr class="t-par"> <td> type </td> <td> - </td> <td> the type of the mutex </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.2 The mtx_init function (p: 277-278) </li></ul> +<li> C11 standard (ISO/IEC 9899:2011): </li> +<ul><li> 7.26.4.2 The mtx_init function (p: 381) </li></ul> +</ul> <h3 id="See_also"> See also</h3> <table class="t-dsc-begin"> <tr class="t-dsc"> <td colspan="2"> <span><a href="https://en.cppreference.com/w/cpp/thread/mutex/mutex" title="cpp/thread/mutex/mutex">C++ documentation</a></span> for <code>mutex</code> </td> +</tr> <tr class="t-dsc"> <td colspan="2"> <span><a href="https://en.cppreference.com/w/cpp/thread/timed_mutex/timed_mutex" title="cpp/thread/timed mutex/timed mutex">C++ documentation</a></span> for <code>timed_mutex</code> </td> +</tr> <tr class="t-dsc"> <td colspan="2"> <span><a href="https://en.cppreference.com/w/cpp/thread/recursive_mutex/recursive_mutex" title="cpp/thread/recursive mutex/recursive mutex">C++ documentation</a></span> for <code>recursive_mutex</code> </td> +</tr> <tr class="t-dsc"> <td colspan="2"> <span><a href="https://en.cppreference.com/w/cpp/thread/recursive_timed_mutex/recursive_timed_mutex" title="cpp/thread/recursive timed mutex/recursive timed mutex">C++ documentation</a></span> for <code>recursive_timed_mutex</code> </td> +</tr> </table> <div class="_attribution"> + <p class="_attribution-p"> + © 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_init" class="_attribution-link">https://en.cppreference.com/w/c/thread/mtx_init</a> + </p> +</div> |