Skip to content

unlock_mutexUnlockMutexUnlockMutexunlock_mutexT_unlock_mutex🔗

Short description🔗

unlock_mutexUnlockMutexUnlockMutexunlock_mutexT_unlock_mutex — Unlock a mutex synchronization object.

Signature🔗

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

Herror T_unlock_mutex( const Htuple MutexHandle )

void HMutex::UnlockMutex( ) const

void HMutex.UnlockMutex( )

Description🔗

unlock_mutexUnlockMutex unlocks the mutex object given by MutexHandlemutexHandlemutex_handle. The mutex must have been locked by the calling thread. Attempting to unlock a mutex that is not locked by the calling thread is undefined behavior.

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.

Parameters🔗

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

Mutex synchronization object.

Result🔗

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

Combinations with other operators🔗

Combinations

Possible predecessors

lock_mutexLockMutex, try_lock_mutexTryLockMutex

Possible successors

lock_mutexLockMutex, try_lock_mutexTryLockMutex, clear_mutexClearMutex

Module🔗

Foundation