tis_cond_destroy

Destroys a condition variable.

Syntax

tis_cond_destroy( cond );

Argument Data Type Access

cond opaque pthread_cond_t write

C Binding

#include 


int
tis_cond_destroy (
            pthread_cond_t   *cond);

Arguments

cond: Address of the condition variable (passed by reference) to be destroyed.

Description

This routine destroys the condition variable specified by cond. This effectively uninitializes the condition variable. Call this routine when a condition variable will no longer be referenced.

The results of this routine are unpredictable if the condition variable specified in cond does not exist or is not initialized.

For more information about actions when threads are present, refer to the pthread_cond_destroy description.

Return Values

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

Return Description

0 Successful completion. [EINVAL] The value specified by cond is invalid. [EBUSY] The object being referenced by cond is being referenced by another thread that is currently executing a tis_cond_wait on the condition variable specified in cond. (This error can only occur when threads are present.)

Associated Routines

   tis_cond_broadcast
   tis_cond_init
   tis_cond_signal
   tis_cond_wait