lib/libpthread/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 .\" $FreeBSD: src/share/man/man3/pthread_cond_destroy.3,v 1.16 2007/10/22 10:08:00 ru Exp $
  29 .\"
  30 .Dd July 10, 2009
  31 .Dt PTHREAD_COND_DESTROY 3
  32 .Os
  33 .Sh NAME
  34 .Nm pthread_cond_destroy
  35 .Nd destroy a condition variable
  36 .Sh LIBRARY
  37 .Lb libpthread
  38 .Sh SYNOPSIS
  39 .In pthread.h
  40 .Ft int
  41 .Fn pthread_cond_destroy "pthread_cond_t *cond"
  42 .Sh DESCRIPTION
  43 The
  44 .Fn pthread_cond_destroy
  45 function frees the resources allocated by the condition variable
  46 .Fa cond .
  47 .Sh RETURN VALUES
  48 If successful, the
  49 .Fn pthread_cond_destroy
  50 function will return zero, otherwise an error number will be returned
  51 to indicate the error.
  52 .Sh ERRORS
  53 The
  54 .Fn pthread_cond_destroy
  55 function will fail if:
  56 .Bl -tag -width Er
  57 .It Bq Er EINVAL
  58 The value specified by
  59 .Fa cond
  60 is invalid.
  61 .It Bq Er EBUSY
  62 The variable
  63 .Fa cond
  64 is locked by another thread.
  65 .El
  66 .Sh SEE ALSO
  67 .Xr pthread_cond_broadcast 3 ,
  68 .Xr pthread_cond_init 3 ,
  69 .Xr pthread_cond_signal 3 ,
  70 .Xr pthread_cond_timedwait 3 ,
  71 .Xr pthread_cond_wait 3
  72 .Sh STANDARDS
  73 The
  74 .Fn pthread_cond_destroy
  75 function conforms to
  76 .St -p1003.1-96 .