cma_mutex_delete

Deletes a mutex.

Syntax

cma_mutex_delete( mutex);

Argument Data Type Access

mutex opaque cma_t_mutex modify

C Binding

#include 


void
cma_mutex_delete (
         cma_t_mutex   *mutex);

Arguments

mutex: Handle of the mutex deleted. After the call to this routine, the mutex argument is set to the value cma_c_null.

Description

This routine deletes a mutex and should be called when a mutex is no longer referenced. Calling this routine reclaims storage for the mutex object.

After the mutex is deleted, the mutex argument is set to the value cma_c_null. Calling this routine and specifying a value of cma_c_null for the mutex argument is legal and has no effect.

Do not delete a mutex that has a current owner (in other words, is locked). If you try to delete a mutex that is locked, the cma_e_in_ use exception is raised.

The results of this routine are unpredictable if the handle specified in the mutex argument refers to a mutex object that does not currently exist (unless it is cma_c_null).

Exceptions

cma_e_existence
cma_e_in_use
cma_e_use_error