Destroys a condition variable.

1  –  C Binding

    #include <pthread.h>

    int
    pthread_cond_destroy (
             pthread_cond_t   *cond);

2  –  Arguments

 cond

    Condition variable to be destroyed.

3  –  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.
    Destroying a condition variable allows the Threads Library to
    reclaim internal memory associated with the condition variable.

    It is safe to destroy an initialized condition variable upon
    which no threads are currently blocked. Attempting to destroy a
    condition variable upon which other threads are blocked results
    in unpredictable behavior.

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

4  –  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 not a valid condition
                variable.
    [EBUSY]     The object being referenced by cond is being
                referenced by another thread that is currently
                executing
                pthread_cond_wait()  or pthread_cond_timedwait() on
                the condition variable specified in cond.

5  –  Associated Routines

       pthread_cond_broadcast()
       pthread_cond_init()
       pthread_cond_signal()
       pthread_cond_timedwait()
       pthread_cond_wait()