Content-type: text/html Man page of tis_mutex_destroy

tis_mutex_destroy

Section: C Library Functions (3)
Index Return to Main Contents
 

NAME

tis_mutex_destroy - Destroys the specified mutex object.  

LIBRARY

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

SYNOPSIS

#include <tis.h>

int tis_mutex_destroy(
                       pthread_mutex_t   *mutex);  

STANDARDS

None  

PARAMETERS

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: Successful completion. An attempt was made to destroy the object referenced by mutex while it is locked or referenced. The value specified by mutex is invalid. The caller does not have privileges to perform the operation.  

ERRORS

None  

RELATED INFORMATION

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

delim off


 

Index

NAME
LIBRARY
SYNOPSIS
STANDARDS
PARAMETERS
DESCRIPTION
RETURN VALUES
ERRORS
RELATED INFORMATION

This document was created by man2html, using the manual pages.
Time: 02:42:16 GMT, October 02, 2010