xref: /minix3/lib/libc/stdlib/atexit.3 (revision 84d9c625bfea59e274550651111ae9edfdc40fbd)
1*84d9c625SLionel Sambuc.\"	$NetBSD: atexit.3,v 1.11 2013/04/26 19:37:04 wiz Exp $
22fe8fb19SBen Gras.\"
32fe8fb19SBen Gras.\" Copyright (c) 1990, 1991, 1993
42fe8fb19SBen Gras.\"	The Regents of the University of California.  All rights reserved.
52fe8fb19SBen Gras.\"
62fe8fb19SBen Gras.\" This code is derived from software contributed to Berkeley by
72fe8fb19SBen Gras.\" Chris Torek and the American National Standards Committee X3,
82fe8fb19SBen Gras.\" on Information Processing Systems.
92fe8fb19SBen Gras.\"
102fe8fb19SBen Gras.\" Redistribution and use in source and binary forms, with or without
112fe8fb19SBen Gras.\" modification, are permitted provided that the following conditions
122fe8fb19SBen Gras.\" are met:
132fe8fb19SBen Gras.\" 1. Redistributions of source code must retain the above copyright
142fe8fb19SBen Gras.\"    notice, this list of conditions and the following disclaimer.
152fe8fb19SBen Gras.\" 2. Redistributions in binary form must reproduce the above copyright
162fe8fb19SBen Gras.\"    notice, this list of conditions and the following disclaimer in the
172fe8fb19SBen Gras.\"    documentation and/or other materials provided with the distribution.
182fe8fb19SBen Gras.\" 3. Neither the name of the University nor the names of its contributors
192fe8fb19SBen Gras.\"    may be used to endorse or promote products derived from this software
202fe8fb19SBen Gras.\"    without specific prior written permission.
212fe8fb19SBen Gras.\"
222fe8fb19SBen Gras.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
232fe8fb19SBen Gras.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
242fe8fb19SBen Gras.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
252fe8fb19SBen Gras.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
262fe8fb19SBen Gras.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
272fe8fb19SBen Gras.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
282fe8fb19SBen Gras.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
292fe8fb19SBen Gras.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
302fe8fb19SBen Gras.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
312fe8fb19SBen Gras.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
322fe8fb19SBen Gras.\" SUCH DAMAGE.
332fe8fb19SBen Gras.\"
342fe8fb19SBen Gras.\"     from: @(#)atexit.3	8.1 (Berkeley) 6/4/93
352fe8fb19SBen Gras.\"
362fe8fb19SBen Gras.Dd June 4, 1993
372fe8fb19SBen Gras.Dt ATEXIT 3
382fe8fb19SBen Gras.Os
392fe8fb19SBen Gras.Sh NAME
402fe8fb19SBen Gras.Nm atexit
412fe8fb19SBen Gras.Nd register a function to be called on exit
422fe8fb19SBen Gras.Sh LIBRARY
432fe8fb19SBen Gras.Lb libc
442fe8fb19SBen Gras.Sh SYNOPSIS
452fe8fb19SBen Gras.In stdlib.h
462fe8fb19SBen Gras.Ft int
472fe8fb19SBen Gras.Fn atexit "void (*function)(void)"
482fe8fb19SBen Gras.Sh DESCRIPTION
492fe8fb19SBen GrasThe
502fe8fb19SBen Gras.Fn atexit
512fe8fb19SBen Grasfunction
522fe8fb19SBen Grasregisters the given
532fe8fb19SBen Gras.Ar function
542fe8fb19SBen Grasto be called at program exit, whether via
552fe8fb19SBen Gras.Xr exit 3
562fe8fb19SBen Grasor via return from the program's
572fe8fb19SBen Gras.Em main .
582fe8fb19SBen GrasFunctions so registered are called in reverse order;
592fe8fb19SBen Grasno arguments are passed.
602fe8fb19SBen GrasAt least 32 functions can always be registered,
612fe8fb19SBen Grasand more are allowed as long as sufficient memory can be allocated.
622fe8fb19SBen Gras.Sh RETURN VALUES
632fe8fb19SBen Gras.Rv -std atexit
642fe8fb19SBen Gras.Sh ERRORS
652fe8fb19SBen Gras.Bl -tag -width Er
662fe8fb19SBen Gras.It Bq Er ENOMEM
672fe8fb19SBen GrasNo memory was available to add the function to the list.
682fe8fb19SBen GrasThe existing list of functions is unmodified.
692fe8fb19SBen Gras.El
702fe8fb19SBen Gras.Sh SEE ALSO
71*84d9c625SLionel Sambuc.Xr at_quick_exit 3 ,
72*84d9c625SLionel Sambuc.Xr exit 3 ,
73*84d9c625SLionel Sambuc.Xr quick_exit 3
742fe8fb19SBen Gras.Sh STANDARDS
752fe8fb19SBen GrasThe
762fe8fb19SBen Gras.Fn atexit
772fe8fb19SBen Grasfunction
782fe8fb19SBen Grasconforms to
792fe8fb19SBen Gras.St -ansiC .
80