original/man3/on_exit.3

   1 .\" Copyright 1993 David Metcalfe (david@prism.demon.co.uk)
   2 .\"
   3 .\" %%%LICENSE_START(VERBATIM)
   4 .\" Permission is granted to make and distribute verbatim copies of this
   5 .\" manual provided the copyright notice and this permission notice are
   6 .\" preserved on all copies.
   7 .\"
   8 .\" Permission is granted to copy and distribute modified versions of this
   9 .\" manual under the conditions for verbatim copying, provided that the
  10 .\" entire resulting derived work is distributed under the terms of a
  11 .\" permission notice identical to this one.
  12 .\"
  13 .\" Since the Linux kernel and libraries are constantly changing, this
  14 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  15 .\" responsibility for errors or omissions, or for damages resulting from
  16 .\" the use of the information contained herein.  The author(s) may not
  17 .\" have taken the same level of care in the production of this manual,
  18 .\" which is licensed free of charge, as they might when working
  19 .\" professionally.
  20 .\"
  21 .\" Formatted or processed versions of this manual, if unaccompanied by
  22 .\" the source, must acknowledge the copyright and authors of this work.
  23 .\" %%%LICENSE_END
  24 .\"
  25 .\" References consulted:
  26 .\"     Linux libc source code
  27 .\"     Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991)
  28 .\"     386BSD man pages
  29 .\" Modified 1993-04-02, David Metcalfe
  30 .\" Modified 1993-07-25, Rik Faith (faith@cs.unc.edu)
  31 .TH ON_EXIT 3  2008-12-05 "GNU" "Linux Programmer's Manual"
  32 .SH NAME
  33 on_exit \- register a function to be called at normal process termination
  34 .SH SYNOPSIS
  35 .nf
  36 .B #include <stdlib.h>
  37 .sp
  38 .BI "int on_exit(void (*" function ")(int , void *), void *" arg );
  39 .fi
  40 .sp
  41 .in -4n
  42 Feature Test Macro Requirements for glibc (see
  43 .BR feature_test_macros (7)):
  44 .in
  45 .sp
  46 .BR on_exit ():
  47 _BSD_SOURCE || _SVID_SOURCE
  48 .SH DESCRIPTION
  49 The
  50 .BR on_exit ()
  51 function registers the given
  52 .I function
  53 to be
  54 called at normal process termination, whether via
  55 .BR exit (3)
  56 or via return from the program's
  57 .IR main ().
  58 The
  59 .I function
  60 is passed the status argument given to the last call to
  61 .BR exit (3)
  62 and the
  63 .I arg
  64 argument from
  65 .BR on_exit ().
  66
  67 The same function may be registered multiple times:
  68 it is called once for each registration.
  69
  70 When a child process is created via
  71 .BR fork (2),
  72 it inherits copies of its parent's registrations.
  73 Upon a successful call to one of the
  74 .BR exec (3)
  75 functions, all registrations are removed.
  76 .SH RETURN VALUE
  77 The
  78 .BR on_exit ()
  79 function returns the value 0 if successful; otherwise
  80 it returns a nonzero value.
  81 .SH CONFORMING TO
  82 This function comes from SunOS 4, but is also present in
  83 libc4, libc5 and glibc.
  84 It no longer occurs in Solaris (SunOS 5).
  85 Avoid this function, and use the standard
  86 .BR atexit (3)
  87 instead.
  88 .SH SEE ALSO
  89 .BR _exit (2),
  90 .BR atexit (3),
  91 .BR exit (3)
  92 .SH COLOPHON
  93 This page is part of release 3.67 of the Linux
  94 .I man-pages
  95 project.
  96 A description of the project,
  97 information about reporting bugs,
  98 and the latest version of this page,
  99 can be found at
 100 \%http://www.kernel.org/doc/man\-pages/.