TutMutexDestroy

Name

TutMutexDestroy — destroy a mutex object

Synopsis

T_BOOL TutMutexDestroy(mutex) 
T_MUTEX mutex;

Arguments

mutex — mutex object to destroy

Return Values

TRUE if mutex object was successfully destroyed, FALSE otherwise.

Diagnostics

If TutMutexDestroy fails, it returns FALSE and sets the global SmartSockets error number to one of:

T_ERR_OS — an operating system error has occurred. Call the function TutErrNumGetOs to obtain the related OS error value.

T_ERR_TYPE_MISMATCH — the platform does not support threads.

T_ERR_VAL_INVALID — mutex was not a valid mutex object.

Description

TutMutexDestroy destroys a mutex object. All operating system resources associated with the mutex are released.

Caution

Destroying a mutex that other threads in the same process have locked or are waiting to lock has undefined results.

Examples

This example creates and then destroys a mutex object:

T_MUTEX mutex; 
mutex = TutMutexCreate(FALSE); 
if (T_INVALID_MUTEX == mutex) { 
  /* error */ 
} 
... 
if (!TutMutexDestroy(mutex)) { 
  /* error */ 
}