Skip to content

clear_mutexClearMutexClearMutexclear_mutexT_clear_mutex🔗

Short description🔗

clear_mutexClearMutexClearMutexclear_mutexT_clear_mutex — Clear the mutex synchronization object.

Signature🔗

clear_mutex( mutex MutexHandle )void ClearMutex( const HTuple& MutexHandle )static void HOperatorSet.ClearMutex( HTuple mutexHandle )def clear_mutex( mutex_handle: HHandle ) -> None

Herror T_clear_mutex( const Htuple MutexHandle )

void HMutex::ClearMutex( ) const

void HMutex.ClearMutex( )

Description🔗

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

Execution information🔗

Execution information

  • Multithreading type: reentrant (runs in parallel with non-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🔗

MutexHandlemutexHandlemutex_handle (input_control, state is modified) mutex → (handle)HTuple (HHandle)HMutex, HTuple (IntPtr)HHandleHtuple (handle)

Mutex synchronization object.

Result🔗

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

Combinations with other operators🔗

Combinations

Possible predecessors

create_mutexCreateMutex

See also

create_mutexCreateMutex

Module🔗

Foundation