lib/libpthread/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/share/man/man3/pthread_cleanup_push.3,v 1.15 2007/10/22 10:08:00 ru Exp $
  29 .\" $DragonFly: src/lib/libc_r/man/pthread_cleanup_push.3,v 1.2 2003/06/17 04:26:47 dillon Exp $
  30 .\"
  31 .Dd July 10, 2009
  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 LIBRARY
  38 .Lb libpthread
  39 .Sh SYNOPSIS
  40 .In pthread.h
  41 .Ft void
  42 .Fn pthread_cleanup_push "void (*cleanup_routine)(void *)" "void *arg"
  43 .Sh DESCRIPTION
  44 The
  45 .Fn pthread_cleanup_push
  46 function adds
  47 .Fa cleanup_routine
  48 to the top of the stack of cleanup handlers that
  49 get called when the current thread exits.
  50 .Pp
  51 When
  52 .Fa cleanup_routine
  53 is called, it is passed
  54 .Fa arg
  55 as its only argument.
  56 .Sh RETURN VALUES
  57 The
  58 .Fn pthread_cleanup_push
  59 function does not return any value.
  60 .Sh ERRORS
  61 None
  62 .Sh SEE ALSO
  63 .Xr pthread_cleanup_pop 3 ,
  64 .Xr pthread_exit 3
  65 .Sh STANDARDS
  66 The
  67 .Fn pthread_cleanup_push
  68 function conforms to
  69 .St -p1003.1-96 .