mirror of https://github.com/mkerrisk/man-pages
73 lines
2.4 KiB
Groff
73 lines
2.4 KiB
Groff
.\" Copyright 1993 David Metcalfe (david@prism.demon.co.uk)
|
|
.\"
|
|
.\" Permission is granted to make and distribute verbatim copies of this
|
|
.\" manual provided the copyright notice and this permission notice are
|
|
.\" preserved on all copies.
|
|
.\"
|
|
.\" Permission is granted to copy and distribute modified versions of this
|
|
.\" manual under the conditions for verbatim copying, provided that the
|
|
.\" entire resulting derived work is distributed under the terms of a
|
|
.\" permission notice identical to this one.
|
|
.\"
|
|
.\" Since the Linux kernel and libraries are constantly changing, this
|
|
.\" manual page may be incorrect or out-of-date. The author(s) assume no
|
|
.\" responsibility for errors or omissions, or for damages resulting from
|
|
.\" the use of the information contained herein. The author(s) may not
|
|
.\" have taken the same level of care in the production of this manual,
|
|
.\" which is licensed free of charge, as they might when working
|
|
.\" professionally.
|
|
.\"
|
|
.\" Formatted or processed versions of this manual, if unaccompanied by
|
|
.\" the source, must acknowledge the copyright and authors of this work.
|
|
.\"
|
|
.\" References consulted:
|
|
.\" Linux libc source code
|
|
.\" Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991)
|
|
.\" 386BSD man pages
|
|
.\" Modified 1993-04-02, David Metcalfe
|
|
.\" Modified 1993-07-25, Rik Faith (faith@cs.unc.edu)
|
|
.TH ON_EXIT 3 2007-07-26 "GNU" "Linux Programmer's Manual"
|
|
.SH NAME
|
|
on_exit \- register a function to be called at normal process termination
|
|
.SH SYNOPSIS
|
|
.nf
|
|
.B #include <stdlib.h>
|
|
.sp
|
|
.BI "int on_exit(void (*" function ")(int , void *), void *" arg );
|
|
.fi
|
|
.sp
|
|
.in -4n
|
|
Feature Test Macro Requirements for glibc (see
|
|
.BR feature_test_macros (7)):
|
|
.in
|
|
.sp
|
|
.BR on_exit ():
|
|
_BSD_SOURCE || _SVID_SOURCE
|
|
.SH DESCRIPTION
|
|
The
|
|
.BR on_exit ()
|
|
function registers the given \fIfunction\fP to be
|
|
called at normal process termination, whether via
|
|
.BR exit (3)
|
|
or via return from the program's \fImain\fP().
|
|
The \fIfunction\fP is passed the argument to
|
|
.BR exit (3)
|
|
and the \fIarg\fP argument from
|
|
.BR on_exit ().
|
|
.SH "RETURN VALUE"
|
|
The
|
|
.BR on_exit ()
|
|
function returns the value 0 if successful; otherwise
|
|
it returns a nonzero value.
|
|
.SH "CONFORMING TO"
|
|
This function comes from SunOS 4, but is also present in
|
|
libc4, libc5 and glibc.
|
|
It no longer occurs in Solaris (SunOS 5).
|
|
Avoid this function, and use the standard
|
|
.BR atexit (3)
|
|
instead.
|
|
.SH "SEE ALSO"
|
|
.BR _exit (2),
|
|
.BR atexit (3),
|
|
.BR exit (3)
|