Move pthread* manpages to lib/libpthread as they are not libc_r specific.
[dragonfly.git] / lib / libpthread / pthread_cond_destroy.3
blobabdb5d3fcc7e824521b52909fdd979518d640d85
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/lib/libc_r/man/pthread_cond_destroy.3,v 1.6.2.5 2001/12/17 10:08:26 ru Exp $
29 .\" $DragonFly: src/lib/libc_r/man/pthread_cond_destroy.3,v 1.2 2003/06/17 04:26:47 dillon Exp $
30 .\"
31 .Dd July 28, 1998
32 .Dt PTHREAD_COND_DESTROY 3
33 .Os
34 .Sh NAME
35 .Nm pthread_cond_destroy
36 .Nd destroy a condition variable
37 .Sh LIBRARY
38 .Lb libc_r
39 .Sh SYNOPSIS
40 .In pthread.h
41 .Ft int
42 .Fn pthread_cond_destroy "pthread_cond_t *cond"
43 .Sh DESCRIPTION
44 The
45 .Fn pthread_cond_destroy
46 function frees the resources allocated by the condition variable
47 .Fa cond .
48 .Sh RETURN VALUES
49 If successful, the
50 .Fn pthread_cond_destroy
51 function will return zero, otherwise an error number will be returned
52 to indicate the error.
53 .Sh ERRORS
54 .Fn pthread_cond_destroy
55 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 .Fn pthread_cond_destroy
74 conforms to
75 .St -p1003.1-96 .