Index Index for
Section 3
Index Alphabetical
listing for P
Bottom of page Bottom of
page		 

pthread_mutex_destroy(3)


NAME

  pthread_mutex_destroy - Destroys a mutex


SYNOPSIS

  #include <pthread.h>

  int pthread_mutex_destroy(
	  pthread_mutex_t *mutex );


LIBRARY

  DECthreads POSIX 1003.1c Library (libpthread.so)


STANDARDS

  Interfaces documented on this reference page conform to industry standards
  as follows:

  IEEE Std 1003.1c-1995, POSIX System Application Program Interface


PARAMETERS

  mutex
      The mutex to be destroyed.


DESCRIPTION

  This routine destroys the specified mutex by uninitializing it, and should
  be called when a mutex object is no longer referenced. After this routine
  is called, DECthreads may reclaim internal storage used by the specified
  mutex.

  It is safe to destroy an initialized mutex that is unlocked. However, it is
  illegal to destroy a locked mutex.

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


RETURN VALUES

  If an error condition occurs, this routine returns an integer value
  indicating the type of error. Possible return values are as follows:

  0   Successful completion.

  [EBUSY]
      An attempt was made to destroy the object referenced by mutex while it
      is locked or referenced.

  [EINVAL]
      The value specified for mutex is invalid.


ERRORS

  None


SEE ALSO

  Functions: pthread_mutex_init(3), pthread_mutex_lock(3),
  pthread_mutex_trylock(3), pthread_mutex_unlock(3)

  Manuals: Guide to DECthreads and Programmer's Guide

Index Index for
Section 3
Index Alphabetical
listing for P
Top of page Top of
page