Sun Microsystems, Inc. gratefully acknowledges The Open Group for
permission to reproduce portions of its copyrighted documentation.
Original documentation from The Open Group can be obtained online at
http://www.opengroup.org/bookstore/.
The Institute of Electrical and Electronics Engineers and The Open
Group, have given us permission to reprint portions of their
documentation.
In the following statement, the phrase ``this text'' refers to portions
of the system documentation.
Portions of this text are reprinted and reproduced in electronic form
in the SunOS Reference Manual, from IEEE Std 1003.1, 2004 Edition,
Standard for Information Technology -- Portable Operating System
Interface (POSIX), The Open Group Base Specifications Issue 6,
Copyright (C) 2001-2004 by the Institute of Electrical and Electronics
Engineers, Inc and The Open Group. In the event of any discrepancy
between these versions and the original IEEE and The Open Group
Standard, the original IEEE and The Open Group Standard is the referee
document. The original Standard can be obtained online at
http://www.opengroup.org/unix/online.html.
This notice shall appear on any product containing this material.
The contents of this file are subject to the terms of the
Common Development and Distribution License (the "License").
You may not use this file except in compliance with the License.
You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
or http://www.opensolaris.org/os/licensing.
See the License for the specific language governing permissions
and limitations under the License.
When distributing Covered Code, include this CDDL HEADER in each
file and include the License file at usr/src/OPENSOLARIS.LICENSE.
If applicable, add the following below this CDDL HEADER, with the
fields enclosed by brackets "[]" replaced with your own identifying
information: Portions Copyright [yyyy] [name of copyright owner]
Copyright 1989 AT&T
Copyright (c) 1997, The Open Group. All Rights Reserved.
Portions Copyright (c) 2001, Sun Microsystems, Inc. All Rights Reserved
#include <stdlib.h> int atexit(void (*func)(void));
The atexit() function registers the function pointed to by func to be called without arguments on normal termination of the program or when the object defining the function is unloaded.
Normal termination occurs by either a call to the exit(3C) function or a return from main(). Object unloading occurs when a call to dlclose(3C) results in the object becoming unreferenced.
The number of functions that may be registered with atexit() is limited only by available memory (refer to the _SC_ATEXIT_MAX argument of sysconf(3C)).
After a successful call to any of the exec(2) functions, any functions previously registered by atexit() are no longer registered.
On process exit, functions are called in the reverse order of their registration. On object unloading, any functions belonging to an unloadable object are called in the reverse order of their registration.
Upon successful completion, the atexit() function returns 0. Otherwise, it returns a non-zero value.
The atexit() function may fail if: ENOMEM
Insufficient storage space is available.
The functions registered by a call to atexit() must return to ensure that all registered functions are called.
There is no way for an application to tell how many functions have already been registered with atexit().
See attributes(7) for descriptions of the following attributes:
| ATTRIBUTE TYPE ATTRIBUTE VALUE |
| Interface Stability Standard |
| MT-Level Safe |
exec (2), dlclose (3C), exit (3C), sysconf (3C), attributes (7)