1.\" $OpenBSD: pthread_cleanup_pop.3,v 1.10 2015/03/13 19:58:41 jmc Exp $
2.\"
3.\" Copyright (c) 1997 Brian Cully <shmit@kublai.com>
4.\" All rights reserved.
5.\"
6.\" Redistribution and use in source and binary forms, with or without
7.\" modification, are permitted provided that the following conditions
8.\" are met:
9.\" 1. Redistributions of source code must retain the above copyright
10.\"    notice, this list of conditions and the following disclaimer.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\"    notice, this list of conditions and the following disclaimer in the
13.\"    documentation and/or other materials provided with the distribution.
14.\" 3. Neither the name of the author nor the names of any co-contributors
15.\"    may be used to endorse or promote products derived from this software
16.\"    without specific prior written permission.
17.\"
18.\" THIS SOFTWARE IS PROVIDED BY JOHN BIRRELL AND CONTRIBUTORS ``AS IS'' AND
19.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
22.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28.\" SUCH DAMAGE.
29.\"
30.\" $FreeBSD: pthread_cleanup_pop.3,v 1.4 1999/08/28 00:03:02 peter Exp $
31.\"
32.Dd $Mdocdate: March 13 2015 $
33.Dt PTHREAD_CLEANUP_POP 3
34.Os
35.Sh NAME
36.Nm pthread_cleanup_pop
37.Nd call the first cleanup routine
38.Sh SYNOPSIS
39.In pthread.h
40.Ft void
41.Fn pthread_cleanup_pop "int execute"
42.Sh DESCRIPTION
43The
44.Fn pthread_cleanup_pop
45function pops the top cleanup routine off of the current thread's cleanup
46routine stack and, if
47.Fa execute
48is non-zero, it will execute the function.
49If there is no cleanup routine then
50.Fn pthread_cleanup_pop
51does nothing.
52.Sh RETURN VALUES
53.Fn pthread_cleanup_pop
54does not return any value.
55.Sh ERRORS
56None
57.Sh SEE ALSO
58.Xr pthread_cleanup_push 3 ,
59.Xr pthread_exit 3
60.Sh STANDARDS
61.Fn pthread_cleanup_pop
62conforms to
63.St -p1003.1-96 .
64