original/man3/on_exit.3

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