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

tis_mutex_destroy(3)


NAME

  tis_mutex_destroy - Destroys the specified mutex object


SYNOPSIS

  #include <tis.h>

  int tis_mutex_destroy(
	  pthread_mutex_t *mutex );


LIBRARY

  Standard C Library (libc.so, libc.a)


STANDARDS

  None


PARAMETERS

  mutex
      Address of the mutex object (passed by reference) to be destroyed.


DESCRIPTION

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

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

  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 by mutex is invalid.

  [EPERM]
      The caller does not have privileges to perform the operation.


ERRORS

  None


SEE ALSO

  Functions: tis_mutex_init(3), tis_mutex_lock(3), tis_mutex_trylock(3),
  tis_mutex_unlock(3)

  Manuals: Guide to DECthreads and Programmer's Guide

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