]> git.saurik.com Git - apple/xnu.git/blobdiff - osfmk/man/lock_make_stable.html
xnu-792.6.76.tar.gz
[apple/xnu.git] / osfmk / man / lock_make_stable.html
index 53a306df6e4026d9780c431d6a14244cddd59095..3170d7c655da98b0f0bbe244f72ebac4832bb35e 100755 (executable)
@@ -1 +1,55 @@
-<h2>lock_make_stable</h2>\r<hr>\r<p>\r<strong>Function</strong> - Stabilize the state of the specified lock.\r<h3>SYNOPSIS</h3>\r<pre>\r<strong>kern_return_t   lock_make_stable</strong>\r                <strong>(lock_set_t</strong>                            <var>lock_set</var>,\r                 <strong>int</strong>                                    <var>lock_id</var><strong>);</strong>\r</pre>\r<h3>PARAMETERS</h3>\r<dl>\r<p>\r<dt> <var>lock_set</var>\r<dd>\r[in send right] The port naming the lock set which represents the\rlock.\r<p>\r<dt> <var>lock_id</var>\r<dd>\r[in scalar] The lock, represented by the lock set, to be stabilized.\r</dl>\r<h3>DESCRIPTION</h3>\r<p>\rThe <strong>lock_make_stable</strong> function clears the specified lock's unstable\rstate, making the lock's state stable again.\r<h3>RETURN VALUES</h3>\r<dl>\r<p>\r<dt> <strong>KERN_INVALID_ARGUMENT</strong>\r<dd>\rThe specified lock set is invalid, or the lock id is out of range.\r     <p>\r     <dt> <strong>KERN_INVALID_RIGHT</strong>\r      <dd>\r        The caller does not own the specified lock.\r<p>\r<dt> <strong>KERN_SUCCESS</strong>\r<dd>\rThe lock's state was stabilized.\r<p>\r<dt> <strong>KERN_LOCK_SET_DESTROYED</strong>\r<dd>\rThe specified lock has been destroyed.\r</dl>\r<h3>RELATED INFORMATION</h3>\r<p>\rFunctions:\r<a href="lock_acquire.html"><strong>lock_acquire</strong></a>,\r<a href="lock_release.html"><strong>lock_release</strong></a>,\r<a href="lock_try.html"><strong>lock_try</strong></a>,\r<a href="lock_handoff.html"><strong>lock_handoff</strong></a>,\r<a href="lock_handoff_accept.html"><strong>lock_handoff_accept</strong></a>,\r<a href="lock_set_create.html"><strong>lock_set_create</strong></a>,\r<a href="lock_set_destroy.html"><strong>lock_set_destroy</strong></a>.\r
\ No newline at end of file
+<h2>lock_make_stable</h2>
+<hr>
+<p>
+<strong>Function</strong> - Stabilize the state of the specified lock.
+<h3>SYNOPSIS</h3>
+<pre>
+<strong>kern_return_t   lock_make_stable</strong>
+                <strong>(lock_set_t</strong>                            <var>lock_set</var>,
+                 <strong>int</strong>                                    <var>lock_id</var><strong>);</strong>
+</pre>
+<h3>PARAMETERS</h3>
+<dl>
+<p>
+<dt> <var>lock_set</var>
+<dd>
+[in send right] The port naming the lock set which represents the
+lock.
+<p>
+<dt> <var>lock_id</var>
+<dd>
+[in scalar] The lock, represented by the lock set, to be stabilized.
+</dl>
+<h3>DESCRIPTION</h3>
+<p>
+The <strong>lock_make_stable</strong> function clears the specified lock's unstable
+state, making the lock's state stable again.
+<h3>RETURN VALUES</h3>
+<dl>
+<p>
+<dt> <strong>KERN_INVALID_ARGUMENT</strong>
+<dd>
+The specified lock set is invalid, or the lock id is out of range.
+     <p>
+     <dt> <strong>KERN_INVALID_RIGHT</strong>
+         <dd>
+              The caller does not own the specified lock.
+<p>
+<dt> <strong>KERN_SUCCESS</strong>
+<dd>
+The lock's state was stabilized.
+<p>
+<dt> <strong>KERN_LOCK_SET_DESTROYED</strong>
+<dd>
+The specified lock has been destroyed.
+</dl>
+<h3>RELATED INFORMATION</h3>
+<p>
+Functions:
+<a href="lock_acquire.html"><strong>lock_acquire</strong></a>,
+<a href="lock_release.html"><strong>lock_release</strong></a>,
+<a href="lock_try.html"><strong>lock_try</strong></a>,
+<a href="lock_handoff.html"><strong>lock_handoff</strong></a>,
+<a href="lock_handoff_accept.html"><strong>lock_handoff_accept</strong></a>,
+<a href="lock_set_create.html"><strong>lock_set_create</strong></a>,
+<a href="lock_set_destroy.html"><strong>lock_set_destroy</strong></a>.