clear_mutexT_clear_mutexClearMutexClearMutex (Operator)

Name

clear_mutexT_clear_mutexClearMutexClearMutex — Clear the mutex synchronization object.

Signature

Description

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.

This operator modifies the state of the following input parameter:

• MutexHandleMutexHandleMutexHandleMutexHandlemutexHandle

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

Parameters

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

See also

create_mutexcreate_mutexCreateMutexCreateMutexCreateMutex

Module

Foundation