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

<h2>lock_release</h2>\r<hr>\r<p>\r<strong>Function</strong> - Release ownership of a lock.\r<h3>SYNOPSIS</h3>\r<pre>\r<strong>kern_return_t   lock_release</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 released.\r</dl>\r<h3>DESCRIPTION</h3>\r<p>\rThe <strong>lock_release</strong> function release the ownership of the specified lock.\rIf the calling thread does not 	own the lock then the call will fail.\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 specified task does not own the specified lock.\r<p>\r<dt> <strong>KERN_SUCCESS</strong>\r<dd>\rThe ownership of the lock was released.\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_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_set_create.html"><strong>lock_set_create</strong></a>,\r<a href="lock_set_destroy.html"><strong>lock_set_destroy</strong></a>.\r