on_exit (3)

Leading comments

Copyright 1993 David Metcalfe (david@prism.demon.co.uk)

%%%LICENSE_START(VERBATIM)
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.

Sin...

(The comments found at the beginning of the groff file "man3/on_exit.3".)

NAME

on_exit - register a function to be called at normal process termination

SYNOPSIS

#include <stdlib.h>

int on_exit(void (*function)(int , void *), void *arg);

Feature Test Macro Requirements for glibc (see feature_test_macros(7)):

on_exit(): _BSD_SOURCE || _SVID_SOURCE

DESCRIPTION

The on_exit() function registers the given function to be called at normal process termination, whether via exit(3) or via return from the program's main(). The function is passed the status argument given to the last call to exit(3) and the arg argument from on_exit().
The same function may be registered multiple times: it is called once for each registration.
When a child process is created via fork(2), it inherits copies of its parent's registrations. Upon a successful call to one of the exec(3) functions, all registrations are removed.

RETURN VALUE

The on_exit() function returns the value 0 if successful; otherwise it returns a nonzero value.

ATTRIBUTES

For an explanation of the terms used in this section, see attributes(7).

Interface	Attribute	Value
on_exit()	Thread safety	MT-Safe

CONFORMING TO

This function comes from SunOS 4, but is also present in glibc. It no longer occurs in Solaris (SunOS 5). Portable application should avoid this function, and use the standard atexit(3) instead.

SEE ALSO

_exit(2), atexit(3), exit(3)

COLOPHON

This page is part of release 4.04 of the Linux man-pages project. A description of the project, information about reporting bugs, and the latest version of this page, can be found at www.kernel.org/doc/man-pages