lock_mutexT_lock_mutexLockMutexLockMutex (Operator)

Name

lock_mutexT_lock_mutexLockMutexLockMutex — Lock a mutex synchronization object.

Signature

lock_mutex( : : MutexHandle : )

Herror T_lock_mutex(const Htuple MutexHandle)

void LockMutex(const HTuple& MutexHandle)

void HMutex::LockMutex() const

static void HOperatorSet.LockMutex(HTuple mutexHandle)

void HMutex.LockMutex()

Description

lock_mutexlock_mutexLockMutexLockMutexLockMutex locks the mutex given by MutexHandleMutexHandleMutexHandleMutexHandlemutexHandle. If the mutex is currently unlocked, it becomes locked and owned by the calling thread, and lock_mutexlock_mutexLockMutexLockMutexLockMutex returns immediately. If the mutex is already locked by another thread, the calling thread waits until the mutex is unlocked. The kind of wait is defined by the mutex' attributes set during creation in create_mutexcreate_mutexCreateMutexCreateMutexCreateMutex.

Execution Information

Parameters

MutexHandleMutexHandleMutexHandleMutexHandlemutexHandle (input_control)  mutex HMutex, HTupleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Mutex synchronization object.

Result

If the mutex handle is valid, the operator lock_mutexlock_mutexLockMutexLockMutexLockMutex returns 2 (H_MSG_TRUE). If necessary, an exception is raised.

Possible Predecessors

create_mutexcreate_mutexCreateMutexCreateMutexCreateMutex

Possible Successors

unlock_mutexunlock_mutexUnlockMutexUnlockMutexUnlockMutex

See also

try_lock_mutextry_lock_mutexTryLockMutexTryLockMutexTryLockMutex

Module

Foundation