1.\" $OpenBSD: pthread_cleanup_push.3,v 1.4 1999/11/24 05:35:31 d Exp $ 2.\" Copyright (c) 1997 Brian Cully <shmit@kublai.com> 3.\" All rights reserved. 4.\" 5.\" Redistribution and use in source and binary forms, with or without 6.\" modification, are permitted provided that the following conditions 7.\" are met: 8.\" 1. Redistributions of source code must retain the above copyright 9.\" notice, this list of conditions and the following disclaimer. 10.\" 2. Redistributions in binary form must reproduce the above copyright 11.\" notice, this list of conditions and the following disclaimer in the 12.\" documentation and/or other materials provided with the distribution. 13.\" 3. Neither the name of the author nor the names of any co-contributors 14.\" may be used to endorse or promote products derived from this software 15.\" without specific prior written permission. 16.\" 17.\" THIS SOFTWARE IS PROVIDED BY JOHN BIRRELL AND CONTRIBUTORS ``AS IS'' AND 18.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 19.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 20.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 21.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 22.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 23.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 24.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 25.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 26.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 27.\" SUCH DAMAGE. 28.\" 29.\" $FreeBSD: pthread_cleanup_push.3,v 1.5 1999/08/28 00:03:02 peter Exp $ 30.\" 31.Dd July 30, 1998 32.Dt PTHREAD_CLEANUP_PUSH 3 33.Os 34.Sh NAME 35.Nm pthread_cleanup_push 36.Nd add a cleanup function for thread exit 37.Sh SYNOPSIS 38.Fd #include <pthread.h> 39.Ft void 40.Fn pthread_cleanup_push "void (*cleanup_routine)(void *)" "void *arg" 41.Sh DESCRIPTION 42The 43.Fn pthread_cleanup_push 44function adds 45.Fa cleanup_routine 46to the top of the stack of cleanup handlers that 47get called when the current thread exits. 48.Pp 49When 50.Fn pthread_cleanup_push 51is called, it is passed 52.Fa arg 53as its only argument. 54.Sh RETURN VALUES 55.Fn pthread_cleanup_push 56does not return any value. 57.Sh ERRORS 58None 59.Sh SEE ALSO 60.Xr pthread_cleanup_pop 3 , 61.Xr pthread_exit 3 62.Sh STANDARDS 63.Fn pthread_cleanup_push 64conforms to ISO/IEC 9945-1 ANSI/IEEE 65.Pq Dq Tn POSIX 66Std 1003.1 Second Edition 1996-07-12. 67