OSTryLockMutex

Syntax

#include <cafe/os.h>

BOOL OSTryLockMutex (OSMutex* mutex);

Parameters

mutex Pointer to mutex.

Return Values

Returns TRUE if the mutex is successfully locked. Otherwise, returns FALSE.

Description

The calling thread tries to lock the mutex. Returns FALSE if the mutex is already locked.

Do Not Call From

Callbacks Do not call this function from any callback function.

See Also

OSInitCond
OSInitMutex
OSLockMutex
OSSignalCond
OSUnlockMutex
OSWaitCond

Revision History

2013-05-08 Automated cleanup pass.
2012-08-01 Cleanup pass.
2010-08-30 Initial version.


CONFIDENTIAL