HALCON Reference Manual 10.0.2

Name

lock_mutexlock_mutexlock_mutexLockMutexLockMutex — Lock a mutex synchronization object.

lock_mutexlock_mutexlock_mutexLockMutexLockMutex locks the mutex given by MutexHandleMutexHandleMutexHandleMutexHandlemutexHandle. If the mutex is currently unlocked, it becomes locked and owned by the calling thread, and lock_mutexlock_mutexlock_mutexLockMutexLockMutex 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_mutexcreate_mutexCreateMutexCreateMutex.

Parallelization

Multithreading type: independent (runs in parallel even with exclusive operators).
Multithreading scope: global (may be called from any thread).
Processed without parallelization.

Parameters

MutexHandleMutexHandleMutexHandleMutexHandlemutexHandle (input_control) mutex → (integer)

Mutex synchronization object.

Result

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