share/man/man3/pthread_cond_destroy.3

   1 .\" Copyright (c) 1997 Brian Cully <shmit@kublai.com>
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. Neither the name of the author nor the names of any co-contributors
  13 .\"    may be used to endorse or promote products derived from this software
  14 .\"    without specific prior written permission.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY JOHN BIRRELL AND CONTRIBUTORS ``AS IS'' AND
  17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .Dd July 28, 1998
  29 .Dt PTHREAD_COND_DESTROY 3
  30 .Os BSD 4
  31 .Sh NAME
  32 .Nm pthread_cond_destroy
  33 .Nd destroy a condition variable
  34 .Sh SYNOPSIS
  35 .Fd #include <pthread.h>
  36 .Ft int
  37 .Fn pthread_cond_destroy "pthread_cond_t *cond"
  38 .Sh DESCRIPTION
  39 The
  40 .Fn pthread_cond_destroy
  41 function frees the resources allocated by the condition variable
  42 .Fa cond .
  43 .Sh RETURN VALUES
  44 If successful, the
  45 .Fn pthread_cond_init
  46 function will return zero, otherwise an error number will be returned
  47 to indicate the error.
  48 .Sh ERRORS
  49 .Fn pthread_cond_destroy
  50 will fail if:
  51 .Bl -tag -width Er
  52 .It Bq Er EINVAL
  53 The value specified by
  54 .Fa cond
  55 is invalid.
  56 .It Bq Er EBUSY
  57 The variable
  58 .Fa cond
  59 is locked by another thread.
  60 .El
  61 .Pp
  62 .Sh SEE ALSO
  63 .Xr pthread_cond_broadcast 3 ,
  64 .Xr pthread_cond_init 3 ,
  65 .Xr pthread_cond_signal 3 ,
  66 .Xr pthread_cond_timedwait 3 ,
  67 .Xr pthread_cond_wait 3
  68 .Sh STANDARDS
  69 .Fn pthread_cond_destroy
  70 conforms to ISO/IEC 9945-1 ANSI/IEEE
  71 .Pq Dq Tn POSIX
  72 Std 1003.1 Second Edition 1996-07-12.