pthread_mutex_destroy

Deletes a mutex.

Syntax

pthread_mutex_destroy( mutex );

Argument Data Type Access

mutex opaque pthread_mutex_t read

C Binding

int
pthread_mutex_destroy (
pthread_mutex_t *mutex);

Arguments

mutex: Mutex deleted.

Description

This routine deletes a mutex and should be called when a mutex object is no longer referenced. This routine reclaims storage used by the mutex object.

It is illegal to delete a locked mutex.

The results of this routine are unpredictable if the mutex object specified in the mutex argument does not currently exist.

Return Values

If an error condition occurs, this routine returns -1 and sets errno to the corresponding error value. Possible return values are as follows:

Return Error Description

0 Successful completion. -1 [EBUSY] An attempt is made to destroy a locked mutex. -1 [EINVAL] The value specified by mutex is invalid.