lock_try

Function - Attempt to acquire access rights to a lock.

SYNOPSIS

kern_return_t   lock_try
                (lock_set_t                            lock_set,
                 int                                    lock_id);

PARAMETERS

lock_set

[in send right] The port naming the lock set which represents the lock.

lock_id

[in scalar] The lock, represented by the lock set, to be acquired.

DESCRIPTION

The lock_try function attempts to acquire the specified lock without blocking. The return value indicates whether the lock was acquired.

RETURN VALUES

KERN_INVALID_ARGUMENT

The specified lock_set is invalid, or the lock_id is out of range.

KERN_SUCCESS

The lock was acquired.

KERN_LOCK_UNSTABLE

The acquired lock has an unstable state.

KERN_LOCK_SET_DESTROYED

The specified lock has been destroyed.

KERN_LOCK_OWNED

Another thread currently owns the requested lock.

KERN_LOCK_OWNED_SELF

The calling thread already owns the lock.

RELATED INFORMATION

Functions: lock_acquire, lock_make_stable, lock_release, lock_handoff, lock_handoff_accept, lock_set_create, lock_set_destroy.