TutMutexLockFast

Name

TutMutexLockFast — lock a high-performance mutex object

Synopsis

T_BOOL TutMutexLockFast(mutex) 
T_MUTEX mutex; 

Arguments

mutex — the mutex object to lock

Return Values

TRUE if the mutex object was successfully locked, FALSE otherwise.

Diagnostics

If TutMutexLockFast fails, it returns FALSE, and sets the global C error number.

Description

TutMutexLockFast performs a blocking (non-time-bounded) lock operation on mutexes created with the TutMutexCreateFast function. If the mutex is not immediately available, the calling thread is suspended until it becomes available.

Caution

Every call to TutMutexLockFast should be balanced by a subsequent call from the same thread to TutMutexUnlock.

See Also

TutMutexCreateFast, TutMutexLock, TutMutexUnlock, TutMutexDestroy

Examples

The example for TutMutexCreateFast on page 144 demonstrates the use of TutMutexLockFast.