clear_mutexclear_mutexClearMutexClearMutex (Operator)

Name

clear_mutexclear_mutexClearMutexClearMutex — Clear the mutex synchronization object.

clear_mutexclear_mutexClearMutexClearMutexClearMutex destroys the mutex object given by MutexHandleMutexHandleMutexHandleMutexHandlemutexHandle. The mutex must be unlocked. After calling clear_mutexclear_mutexClearMutexClearMutexClearMutex, the mutex can no longer be used. The handle MutexHandleMutexHandleMutexHandleMutexHandlemutexHandle 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.

Parameters

MutexHandleMutexHandleMutexHandleMutexHandlemutexHandle (input_control) mutex → (integer)

Mutex synchronization object.

Result

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

Possible Predecessors

create_mutexcreate_mutexCreateMutexCreateMutexCreateMutex

Module

Foundation

Operators