pthreads/pthread_cleanup_push.3

   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 .\" $FreeBSD: src/lib/libc_r/man/pthread_cleanup_push.3,v 1.5.2.4 2001/08/17 15:42:51 ru Exp $
  29 .\"
  30 .Dd July 30, 1998
  31 .Dt PTHREAD_CLEANUP_PUSH 3
  32 .Os
  33 .Sh NAME
  34 .Nm pthread_cleanup_push
  35 .Nd add a cleanup function for thread exit
  36 .Sh SYNOPSIS
  37 .Fd #include <pthread.h>
  38 .Ft void
  39 .Fn pthread_cleanup_push "void \*[lp]*cleanup_routine\*[rp]\*[lp]void *\*[rp]" "void *arg"
  40 .Sh DESCRIPTION
  41 The
  42 .Fn pthread_cleanup_push
  43 function adds
  44 .Fa cleanup_routine
  45 to the top of the stack of cleanup handlers that
  46 get called when the current thread exits.
  47 .Pp
  48 When
  49 .Fa cleanup_routine
  50 is called, it is passed
  51 .Fa arg
  52 as its only argument.
  53 .Sh RETURN VALUES
  54 .Fn pthread_cleanup_push
  55 does not return any value.
  56 .Sh ERRORS
  57 None
  58 .Sh SEE ALSO
  59 .Xr pthread_cleanup_pop 3 ,
  60 .Xr pthread_exit 3
  61 .Sh STANDARDS
  62 .Fn pthread_cleanup_push
  63 conforms to
  64 .St -p1003.1-96 .