OSReleaseSpinLock

Syntax

#include <cafe/os.h>

BOOL OSReleaseSpinLock(OSSpinLock* spinlock);

Parameters

spinlock Pointer to OSSpinLock to release.

Return Values

Returns TRUE if the lock was released, or FALSE otherwise.

Description

Releases the per-thread OSSpinLock. After this OS function returns and the recursion count drops to zero, any other threads currently waiting to acquire the OSSpinLock may then acquire the OSSpinLock.

Do Not Call From

Callbacks Do not call this function from any callback function.

See Also

OSAcquireSpinLock
OSTryAcquireSpinLock
OSTryAcquireSpinLockWithTimeout
OSInitSpinLock

Revision History

2013-06-21 Clarify the return value.
2013-05-08 Automated cleanup pass.
2012-07-31 Cleanup Pass.
2012-07-31 Matched actual prototype.
2010-08-23 Initial version.


CONFIDENTIAL