Operator Reference

HALCON Operator Reference / System / Multithreading
ClassesClasses | | Operators

clear_mutexT_clear_mutexClearMutexClearMutexclear_mutex (Operator)

clear_mutexT_clear_mutexClearMutexClearMutexclear_mutex — Clear the mutex synchronization object.

Signature

clear_mutex( : : MutexHandle : )

Herror T_clear_mutex(const Htuple MutexHandle)

void ClearMutex(const HTuple& MutexHandle)

void HMutex::ClearMutex() const

static void HOperatorSet.ClearMutex(HTuple mutexHandle)

void HMutex.ClearMutex()

def clear_mutex(mutex_handle: HHandle) -> None

Description

clear_mutexclear_mutexClearMutexClearMutexclear_mutex destroys the mutex object given by MutexHandleMutexHandleMutexHandlemutexHandlemutex_handle. The mutex must be unlocked. After calling clear_mutexclear_mutexClearMutexClearMutexclear_mutex, the mutex can no longer be used. The handle MutexHandleMutexHandleMutexHandlemutexHandlemutex_handle becomes invalid.

Execution Information

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

This operator modifies the state of the following input parameter:

During execution of this operator, access to the value of this parameter must be synchronized if it is used across multiple threads.

Parameters

MutexHandleMutexHandleMutexHandlemutexHandlemutex_handle (input_control, state is modified)  mutex → HMutex, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Mutex synchronization object.

Result

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

Possible Predecessors

create_mutexcreate_mutexCreateMutexCreateMutexcreate_mutex

See also

create_mutexcreate_mutexCreateMutexCreateMutexcreate_mutex

Module

Foundation

ClassesClasses | | Operators