1<h2>lock_set_destroy</h2>
2<hr>
3<p>
4<strong>Function</strong> - Destroy a lock set and its associated locks.
5<h3>SYNOPSIS</h3>
6<pre>
7<strong>kern_return_t   lock_set_destroy</strong>
8                <strong>(task_t</strong>                                    <var>task</var>,
9                 <strong>lock_set_t</strong>                            <var>lock_set</var><strong>);</strong>
10</pre>
11<h3>PARAMETERS</h3>
12<dl>
13<p>
14<dt> <var>task</var>
15<dd>
16The task associated with the lock set.
17<p>
18<dt> <var>lock_set</var>
19<dd>
20[in send right] The port naming the lock set being destroyed.
21</dl>
22<h3>DESCRIPTION</h3>
23<p>
24The <strong>lock_set_destroy</strong> function will destroy a lock set and all of its
25associated locks. Threads that are blocked on locks represented by the
26destroyed lock set are unblocked and will receive a
27KERN_LOCK_SET_DESTROYED error message indicating that the lock set was
28destroyed. The <strong>lock_set_destroy</strong> function will only succeed if the
29specified task is associated with the specified lock set.
30<h3>RETURN VALUES</h3>
31<dl>
32<p>
33<dt> <strong>KERN_INVALID_ARGUMENT</strong>
34<dd>
35The specified lock set or task is invalid.
36     <p>
37     <dt> <strong>KERN_INVALID_RIGHT</strong>
38	  <dd>
39	       The specified task does not own the specified lock set.
40<p>
41     <dt> <strong>KERN_LOCK_SET_DESTROYED</strong>
42	  <dd>
43	       The specified lock set does not exist.
44<p>
45<dt> <strong>KERN_SUCCESS</strong>
46<dd>
47The lock set was destroyed.
48</dl>
49<h3>RELATED INFORMATION</h3>
50<p>
51Functions:
52<a href="lock_acquire.html"><strong>lock_acquire</strong></a>,
53<a href="lock_make_stable.html"><strong>lock_make_stable</strong></a>,
54<a href="lock_try.html"><strong>lock_try</strong></a>,
55<a href="lock_handoff.html"><strong>lock_handoff</strong></a>,
56<a href="lock_handoff_accept.html"><strong>lock_handoff_accept</strong></a>,
57<a href="lock_try.html"><strong>lock_try</strong></a>,
58<a href="lock_set_create.html"><strong>lock_set_create</strong></a>.
59