1 .\" Copyright 1993 David Metcalfe (david@prism.demon.co.uk)
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.
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.
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
21 .\" Formatted or processed versions of this manual, if unaccompanied by
22 .\" the source, must acknowledge the copyright and authors of this work.
25 .\" References consulted:
26 .\" Linux libc source code
27 .\" Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991)
29 .\" Modified 1993-04-02, David Metcalfe
30 .\" Modified 1993-07-25, Rik Faith (faith@cs.unc.edu)
31 .TH ON_EXIT 3 2021-03-22 "GNU" "Linux Programmer's Manual"
33 on_exit \- register a function to be called at normal process termination
36 .B #include <stdlib.h>
38 .BI "int on_exit(void (*" function ")(int, void *), void *" arg );
42 Feature Test Macro Requirements for glibc (see
43 .BR feature_test_macros (7)):
50 Glibc 2.19 and earlier:
51 _BSD_SOURCE || _SVID_SOURCE
56 function registers the given
59 called at normal process termination, whether via
61 or via return from the program's
65 is passed the status argument given to the last call to
72 The same function may be registered multiple times:
73 it is called once for each registration.
75 When a child process is created via
77 it inherits copies of its parent's registrations.
78 Upon a successful call to one of the
80 functions, all registrations are removed.
84 function returns the value 0 if successful; otherwise
85 it returns a nonzero value.
87 For an explanation of the terms used in this section, see
95 Interface Attribute Value
98 T} Thread safety MT-Safe
104 This function comes from SunOS 4, but is also present in glibc.
105 It no longer occurs in Solaris (SunOS 5).
106 Portable application should avoid this function, and use the standard
114 variables may already have gone out of scope.
117 should not be a pointer to a stack variable;
118 it may however be a pointer to a heap variable or a global variable.