ON_EXIT

Section: Linux Programmer's Manual (3)
Updated: 2008-12-05
Index Return to Main Contents

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 non-zero value.

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 atexit(3) instead.

COLOPHON

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