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 \fIfunction\fP to be
  52 called at normal process termination, whether via
  53 .BR exit (3)
  54 or via return from the program's \fImain\fP().
  55 The \fIfunction\fP is passed the status argument given to the last call to
  56 .BR exit (3)
  57 and the \fIarg\fP argument from
  58 .BR on_exit ().
  59
  60 The same function may be registered multiple times:
  61 it is called once for each registration.
  62
  63 When a child process is created via
  64 .BR fork (2),
  65 it inherits copies of its parent's registrations.
  66 Upon a successful call to one of the
  67 .BR exec (3)
  68 functions, all registrations are removed.
  69 .SH RETURN VALUE
  70 The
  71 .BR on_exit ()
  72 function returns the value 0 if successful; otherwise
  73 it returns a nonzero value.
  74 .SH CONFORMING TO
  75 This function comes from SunOS 4, but is also present in
  76 libc4, libc5 and glibc.
  77 It no longer occurs in Solaris (SunOS 5).
  78 Avoid this function, and use the standard
  79 .BR atexit (3)
  80 instead.
  81 .SH SEE ALSO
  82 .BR _exit (2),
  83 .BR atexit (3),
  84 .BR exit (3)