pthreads/pthread_cleanup_pop.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_pop.3,v 1.5.2.3 2001/08/17 15:42:51 ru Exp $
  29 .\"
  30 .Dd July 30, 1998
  31 .Dt PTHREAD_CLEANUP_POP 3
  32 .Os
  33 .Sh NAME
  34 .Nm pthread_cleanup_pop
  35 .Nd call the first cleanup routine
  36 .Sh SYNOPSIS
  37 .Fd #include <pthread.h>
  38 .Ft void
  39 .Fn pthread_cleanup_pop "int execute"
  40 .Sh DESCRIPTION
  41 The
  42 .Fn pthread_cleanup_pop
  43 function pops the top cleanup routine off
  44 of the current thread's cleanup routine stack and, if
  45 .Fa execute
  46 is non-zero, it will execute the function.
  47 If there is no cleanup routine,
  48 .Fn pthread_cleanup_pop
  49 does nothing.
  50 .Pp
  51 .Fn pthread_cleanup_pop
  52 must be paired with a corresponding
  53 .Xr pthread_cleanup_push 3
  54 in the same lexical scope.
  55 .Sh RETURN VALUES
  56 .Fn pthread_cleanup_pop
  57 does not return any value.
  58 .Sh ERRORS
  59 None
  60 .Sh SEE ALSO
  61 .Xr pthread_cleanup_push 3 ,
  62 .Xr pthread_exit 3
  63 .Sh STANDARDS
  64 .Fn pthread_cleanup_pop
  65 conforms to
  66 .St -p1003.1-96 .