xref: /freebsd/share/man/man3/pthread_cleanup_pop.3 (revision 1fbdc08dfe31ed5114e24f014a12eb08e371a3a6)
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 30, 1998
29.Dt PTHREAD_CLEANUP_POP 3
30.Os BSD 4
31.Sh NAME
32.Nm pthread_cleanup_pop
33.Nd call the first cleanup routine
34.Sh SYNOPSIS
35.Fd #include <pthread.h>
36.Ft void
37.Fn pthread_cleanup_pop "int execute"
38.Sh DESCRIPTION
39The
40.Fn pthread_cleanup_pop
41function pops the top cleanup routine off of the current threads cleanup
42routine stack, and, if
43.Fa execute
44is non-zero, it will execute the function. If there is no cleanup routine
45then
46.Fn pthread_cleanup_pop
47does nothing.
48.Sh RETURN VALUES
49.Fn pthread_cleanup_pop
50does not return any value.
51.Sh ERRORS
52None
53.Sh SEE ALSO
54.Xr pthread_cleanup_push 3 ,
55.Xr pthread_exit 3
56.Sh STANDARDS
57.Fn pthread_cleanup_pop
58is expected to conform to IEEE
59.Pq Dq Tn POSIX
60Std 1003.1c when it is published.
61