Manpage of ON_EXIT

ON_EXIT

Section: NEWLIB (3)
Updated: 2005 Feb 23
Index Return to Main Contents

NAME

1.28 `on_exit'--request execution of function with argument at program exit

SYNOPSIS

#include <stdlib.h>
int on_exit (void (*FUNCTION)(int, void *), void *ARG);

DESCRIPTION

You can use `on_exit' to enroll functions in a list of functions that will be called when your program terminates normally. The argument is a pointer to a user-defined function which takes two arguments. The first is the status code passed to exit and the second argument is of type pointer to void. The function must not return a result. The value of ARG is registered and passed as the argument to FUNCTION.

The functions are kept in a LIFO stack; that is, the last function enrolled by `atexit' or `on_exit' will be the first to execute when your program exits. You can intermix functions using `atexit' and `on_exit'.

There is no built-in limit to the number of functions you can enroll in this list; however, after every group of 32 functions is enrolled, `atexit'/`on_exit' will call `malloc' to get space for the next part of the list. The initial list of 32 functions is statically allocated, so you can always count on at least that many slots available.

RETURNS

`on_exit' returns `0' if it succeeds in enrolling your function, `-1' if it fails (possible only if no space was available for `malloc' to extend the list of functions).

PORTABILITY

`on_exit' is a non-standard glibc extension

Supporting OS subroutines required: None

This document was created by man2html, using the manual pages.
Time: 21:25:28 GMT, May 16, 2005