xref: /openbsd-src/lib/libpthread/man/pthread_cleanup_push.3 (revision 62a742911104f98b9185b2c6b6007d9b1c36396c)
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_PUSH 3
30.Os
31.Sh NAME
32.Nm pthread_cleanup_push
33.Nd add a cleanup function for thread exit
34.Sh SYNOPSIS
35.Fd #include <pthread.h>
36.Ft void
37.Fn pthread_cleanup_push "void (*cleanup_routine)(void *)" "void *arg"
38.Sh DESCRIPTION
39The
40.Fn pthread_cleanup_push
41function adds
42.Fa cleanup_routine
43to the top of the stack of cleanup handlers that
44get called when the current thread exits.
45.Pp
46When
47.Fn pthread_cleanup_push
48is called, it is passed
49.Fa arg
50as its only argument.
51.Sh RETURN VALUES
52.Fn pthread_cleanup_push
53does not return any value.
54.Sh ERRORS
55None
56.Sh SEE ALSO
57.Xr pthread_cleanup_pop 3 ,
58.Xr pthread_exit 3
59.Sh STANDARDS
60.Fn pthread_cleanup_push
61conforms to ISO/IEC 9945-1 ANSI/IEEE
62.Pq Dq Tn POSIX
63Std 1003.1 Second Edition 1996-07-12.
64