| 9bccf70c |
1 | <h2>lock_acquire</h2>\r<hr>\r<p>\r<strong>Function</strong> - Acquire access rights to a lock.\r<h3>SYNOPSIS</h3>\r<pre>\r<strong>kern_return_t lock_acquire</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 acquired.\r</dl>\r<h3>DESCRIPTION</h3>\r<p>\rThe <strong>lock_acquire</strong> function acquires access rights to a specific lock\rbeing represented by a given lock set. If the lock is already\rcontrolled by another thread then the calling thread will block.\r<h3>RETURN VALUES</h3>\r<dl>\r<p>\r<dt> <strong>KERN_SUCCESS</strong>\r<dd>\rThe lock was acquired.\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_LOCK_UNSTABLE</strong>\r<dd>\rThe acquired lock has an unstable state.\r <p>\r<dt> <strong>KERN_LOCK_SET_DESTROYED</strong>\r<dd>\rThe specified lock has been destroyed.\r<p>\r<dt> <strong>KERN_ABORTED</strong>\r<dd>\rWhile blocked to wait for the specified lock to become available, the calling\r thread was awoken by an unrelated event, such as thread termination.\r</dl>\r<h3>RELATED INFORMATION</h3>\r<p>\rFunctions:\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_make_stable.html"><strong>lock_make_stable</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 |
projects / apple / xnu.git / blame