rmutex_destroy(SYNCH)

rmutex_destroy -- destroy a recursive mutex

Synopsis

   cc [options] -Kthread file
   
   #include <synch.h>
   

   int rmutex_destroy(rmutex_t *rmutex);

Description

rmutex_destroy destroys the recursive mutual exclusion lock (rmutex) pointed to by rmutex. This includes invalidating the rmutex and freeing any associated implementation-allocated dynamic resources.

Parameters

rmutex: pointer to recursive mutex to be destroyed

Any user-allocated dynamic storage is unaffected by rmutex_destroy and must be explicitly released by the program.

Return values

rmutex_destroy returns zero for success and an error number for failure.

Errors

If any of the following conditions is detected, rmutex_destroy returns the corresponding value:

EBUSY: rmutex is locked by another thread or another thread is waiting to acquire rmutex
EINVAL: invalid argument specified
EINVAL: the rmutex pointed to by rmutex was already destroyed

References

Intro(SYNCH), mutex(SYNCH), rmutex(SYNCH), rmutex_init(SYNCH), rmutex_lock(SYNCH), rmutex_trylock(SYNCH), rmutex_unlock(SYNCH)