xref: /freebsd/share/man/man3/pthread_cond_destroy.3 (revision 74bf4e164ba5851606a27d4feff27717452583e5)
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$
29.\"
30.Dd July 28, 1998
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 libc_r
38.Lb libpthread
39.Lb libthr
40.Sh SYNOPSIS
41.In pthread.h
42.Ft int
43.Fn pthread_cond_destroy "pthread_cond_t *cond"
44.Sh DESCRIPTION
45The
46.Fn pthread_cond_destroy
47function frees the resources allocated by the condition variable
48.Fa cond .
49.Sh RETURN VALUES
50If successful, the
51.Fn pthread_cond_destroy
52function will return zero, otherwise an error number will be returned
53to indicate the error.
54.Sh ERRORS
55The
56.Fn pthread_cond_destroy
57function will fail if:
58.Bl -tag -width Er
59.It Bq Er EINVAL
60The value specified by
61.Fa cond
62is invalid.
63.It Bq Er EBUSY
64The variable
65.Fa cond
66is locked by another thread.
67.El
68.Sh SEE ALSO
69.Xr pthread_cond_broadcast 3 ,
70.Xr pthread_cond_init 3 ,
71.Xr pthread_cond_signal 3 ,
72.Xr pthread_cond_timedwait 3 ,
73.Xr pthread_cond_wait 3
74.Sh STANDARDS
75The
76.Fn pthread_cond_destroy
77function conforms to
78.St -p1003.1-96 .
79