1.\" $OpenBSD: pthread_cleanup_push.3,v 1.7 2013/06/05 03:44:50 tedu 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_push.3,v 1.5 1999/08/28 00:03:02 peter Exp $
31.\"
32.Dd $Mdocdate: June 5 2013 $
33.Dt PTHREAD_CLEANUP_PUSH 3
34.Os
35.Sh NAME
36.Nm pthread_cleanup_push
37.Nd add a cleanup function for thread exit
38.Sh SYNOPSIS
39.In pthread.h
40.Ft void
41.Fn pthread_cleanup_push "void (*cleanup_routine)(void *)" "void *arg"
42.Sh DESCRIPTION
43The
44.Fn pthread_cleanup_push
45function adds
46.Fa cleanup_routine
47to the top of the stack of cleanup handlers that
48get called when the current thread exits.
49.Pp
50When
51.Fa cleanup_routine
52is called, it is passed
53.Fa arg
54as its only argument.
55.Sh RETURN VALUES
56.Fn pthread_cleanup_push
57does not return any value.
58.Sh ERRORS
59None
60.Sh SEE ALSO
61.Xr pthread_cleanup_pop 3 ,
62.Xr pthread_exit 3
63.Sh STANDARDS
64.Fn pthread_cleanup_push
65conforms to
66.St -p1003.1-96 .
67