xnu-792.21.3.tar.gz

[apple/xnu.git] / osfmk / man / lock_set_destroy.html

diff --git a/osfmk/man/lock_set_destroy.html b/osfmk/man/lock_set_destroy.html
index aa81470eab5e54806e7d2b0a6b72a45b093ff85f..f32c806867dd87d9caa31b96ff04c5d5657e558c 100755 (executable)
--- a/osfmk/man/lock_set_destroy.html
+++ b/osfmk/man/lock_set_destroy.html
@@ -1 +1,58 @@
-<h2>lock_set_destroy</h2>\r<hr>\r<p>\r<strong>Function</strong> - Destroy a lock set and its associated locks.\r<h3>SYNOPSIS</h3>\r<pre>\r<strong>kern_return_t   lock_set_destroy</strong>\r                <strong>(task_t</strong>                                    <var>task</var>,\r                 <strong>lock_set_t</strong>                            <var>lock_set</var><strong>);</strong>\r</pre>\r<h3>PARAMETERS</h3>\r<dl>\r<p>\r<dt> <var>task</var>\r<dd>\rThe task associated with the lock set.\r<p>\r<dt> <var>lock_set</var>\r<dd>\r[in send right] The port naming the lock set being destroyed.\r</dl>\r<h3>DESCRIPTION</h3>\r<p>\rThe <strong>lock_set_destroy</strong> function will destroy a lock set and all of its\rassociated locks. Threads that are blocked on locks represented by the\rdestroyed lock set are unblocked and will receive a\rKERN_LOCK_SET_DESTROYED error message indicating that the lock set was\rdestroyed. The <strong>lock_set_destroy</strong> function will only succeed if the\rspecified task is associated with the specified lock set.\r<h3>RETURN VALUES</h3>\r<dl>\r<p>\r<dt> <strong>KERN_INVALID_ARGUMENT</strong>\r<dd>\rThe specified lock set or task is invalid.\r     <p>\r     <dt> <strong>KERN_INVALID_RIGHT</strong>\r   <dd>\r        The specified task does not own the specified lock set.\r<p>\r     <dt> <strong>KERN_LOCK_SET_DESTROYED</strong>\r    <dd>\r        The specified lock set does not exist.\r<p>\r<dt> <strong>KERN_SUCCESS</strong>\r<dd>\rThe lock set was 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_make_stable.html"><strong>lock_make_stable</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_try.html"><strong>lock_try</strong></a>,\r<a href="lock_set_create.html"><strong>lock_set_create</strong></a>.\r
\ No newline at end of file
+<h2>lock_set_destroy</h2>
+<hr>
+<p>
+<strong>Function</strong> - Destroy a lock set and its associated locks.
+<h3>SYNOPSIS</h3>
+<pre>
+<strong>kern_return_t   lock_set_destroy</strong>
+                <strong>(task_t</strong>                                    <var>task</var>,
+                 <strong>lock_set_t</strong>                            <var>lock_set</var><strong>);</strong>
+</pre>
+<h3>PARAMETERS</h3>
+<dl>
+<p>
+<dt> <var>task</var>
+<dd>
+The task associated with the lock set.
+<p>
+<dt> <var>lock_set</var>
+<dd>
+[in send right] The port naming the lock set being destroyed.
+</dl>
+<h3>DESCRIPTION</h3>
+<p>
+The <strong>lock_set_destroy</strong> function will destroy a lock set and all of its
+associated locks. Threads that are blocked on locks represented by the
+destroyed lock set are unblocked and will receive a
+KERN_LOCK_SET_DESTROYED error message indicating that the lock set was
+destroyed. The <strong>lock_set_destroy</strong> function will only succeed if the
+specified task is associated with the specified lock set.
+<h3>RETURN VALUES</h3>
+<dl>
+<p>
+<dt> <strong>KERN_INVALID_ARGUMENT</strong>
+<dd>
+The specified lock set or task is invalid.
+     <p>
+     <dt> <strong>KERN_INVALID_RIGHT</strong>
+         <dd>
+              The specified task does not own the specified lock set.
+<p>
+     <dt> <strong>KERN_LOCK_SET_DESTROYED</strong>
+         <dd>
+              The specified lock set does not exist.
+<p>
+<dt> <strong>KERN_SUCCESS</strong>
+<dd>
+The lock set was destroyed.
+</dl>
+<h3>RELATED INFORMATION</h3>
+<p>
+Functions:
+<a href="lock_acquire.html"><strong>lock_acquire</strong></a>,
+<a href="lock_make_stable.html"><strong>lock_make_stable</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_try.html"><strong>lock_try</strong></a>,
+<a href="lock_set_create.html"><strong>lock_set_create</strong></a>.