summaryrefslogtreecommitdiff
path: root/static/freebsd/man3/pthread_mutex_init.3 3.html
diff options
context:
space:
mode:
authorJacob McDonnell <jacob@jacobmcdonnell.com>2026-04-25 19:55:43 -0400
committerJacob McDonnell <jacob@jacobmcdonnell.com>2026-04-25 19:55:43 -0400
commitac5e55f5f2af5b92794c2aded46c6bae85b5f5ed (patch)
tree9367490586c84cba28652e443e3166d66c33b0d9 /static/freebsd/man3/pthread_mutex_init.3 3.html
parent253e67c8b3a72b3a4757fdbc5845297628db0a4a (diff)
docs: Added All FreeBSD Manuals
Diffstat (limited to 'static/freebsd/man3/pthread_mutex_init.3 3.html')
-rw-r--r--static/freebsd/man3/pthread_mutex_init.3 3.html76
1 files changed, 76 insertions, 0 deletions
diff --git a/static/freebsd/man3/pthread_mutex_init.3 3.html b/static/freebsd/man3/pthread_mutex_init.3 3.html
new file mode 100644
index 00000000..883374ac
--- /dev/null
+++ b/static/freebsd/man3/pthread_mutex_init.3 3.html
@@ -0,0 +1,76 @@
+<table class="head">
+ <tr>
+ <td class="head-ltitle">PTHREAD_MUTEX_INIT(3)</td>
+ <td class="head-vol">Library Functions Manual</td>
+ <td class="head-rtitle">PTHREAD_MUTEX_INIT(3)</td>
+ </tr>
+</table>
+<div class="manual-text">
+<section class="Sh">
+<h1 class="Sh" id="NAME"><a class="permalink" href="#NAME">NAME</a></h1>
+<p class="Pp"><code class="Nm">pthread_mutex_init</code> &#x2014;
+ <span class="Nd">create a mutex</span></p>
+</section>
+<section class="Sh">
+<h1 class="Sh" id="LIBRARY"><a class="permalink" href="#LIBRARY">LIBRARY</a></h1>
+<p class="Pp"><span class="Lb">POSIX Threads Library (libpthread,
+ -lpthread)</span></p>
+</section>
+<section class="Sh">
+<h1 class="Sh" id="SYNOPSIS"><a class="permalink" href="#SYNOPSIS">SYNOPSIS</a></h1>
+<p class="Pp"><code class="In">#include
+ &lt;<a class="In">pthread.h</a>&gt;</code></p>
+<p class="Pp"><var class="Ft">int</var>
+ <br/>
+ <code class="Fn">pthread_mutex_init</code>(<var class="Fa" style="white-space: nowrap;">pthread_mutex_t
+ *restrict mutex</var>, <var class="Fa" style="white-space: nowrap;">const
+ pthread_mutexattr_t *restrict attr</var>);</p>
+</section>
+<section class="Sh">
+<h1 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h1>
+<p class="Pp">The
+ <a class="permalink" href="#pthread_mutex_init"><code class="Fn" id="pthread_mutex_init">pthread_mutex_init</code></a>()
+ function creates a new mutex, with attributes specified with
+ <var class="Fa">attr</var>. If <var class="Fa">attr</var> is NULL the
+ default attributes are used.</p>
+</section>
+<section class="Sh">
+<h1 class="Sh" id="RETURN_VALUES"><a class="permalink" href="#RETURN_VALUES">RETURN
+ VALUES</a></h1>
+<p class="Pp">If successful, <code class="Fn">pthread_mutex_init</code>() will
+ return zero and put the new mutex id into <var class="Fa">mutex</var>,
+ otherwise an error number will be returned to indicate the error.</p>
+</section>
+<section class="Sh">
+<h1 class="Sh" id="ERRORS"><a class="permalink" href="#ERRORS">ERRORS</a></h1>
+<p class="Pp">The <code class="Fn">pthread_mutex_init</code>() function will
+ fail if:</p>
+<dl class="Bl-tag">
+ <dt id="EINVAL">[<a class="permalink" href="#EINVAL"><code class="Er">EINVAL</code></a>]</dt>
+ <dd>The value specified by <var class="Fa">attr</var> is invalid.</dd>
+ <dt id="ENOMEM">[<a class="permalink" href="#ENOMEM"><code class="Er">ENOMEM</code></a>]</dt>
+ <dd>The process cannot allocate enough memory to create another mutex.</dd>
+</dl>
+</section>
+<section class="Sh">
+<h1 class="Sh" id="SEE_ALSO"><a class="permalink" href="#SEE_ALSO">SEE
+ ALSO</a></h1>
+<p class="Pp"><a class="Xr">pthread_mutex_destroy(3)</a>,
+ <a class="Xr">pthread_mutex_lock(3)</a>,
+ <a class="Xr">pthread_mutex_trylock(3)</a>,
+ <a class="Xr">pthread_mutex_unlock(3)</a>,
+ <a class="Xr">pthread_mutexattr(3)</a></p>
+</section>
+<section class="Sh">
+<h1 class="Sh" id="STANDARDS"><a class="permalink" href="#STANDARDS">STANDARDS</a></h1>
+<p class="Pp">The <code class="Fn">pthread_mutex_init</code>() function conforms
+ to <span class="St">ISO/IEC 9945-1:1996
+ (&#x201C;POSIX.1&#x201D;)</span>.</p>
+</section>
+</div>
+<table class="foot">
+ <tr>
+ <td class="foot-date">August 17, 2018</td>
+ <td class="foot-os">FreeBSD 15.0</td>
+ </tr>
+</table>