mirror of
https://git.FreeBSD.org/src.git
synced 2024-12-26 11:47:31 +00:00
104 lines
3.3 KiB
Groff
104 lines
3.3 KiB
Groff
.\" Copyright (c) 1990, 1991, 1993
|
|
.\" The Regents of the University of California. All rights reserved.
|
|
.\"
|
|
.\" This code is derived from software contributed to Berkeley by
|
|
.\" Chris Torek and the American National Standards Committee X3,
|
|
.\" on Information Processing Systems.
|
|
.\"
|
|
.\" Redistribution and use in source and binary forms, with or without
|
|
.\" modification, are permitted provided that the following conditions
|
|
.\" are met:
|
|
.\" 1. Redistributions of source code must retain the above copyright
|
|
.\" notice, this list of conditions and the following disclaimer.
|
|
.\" 2. Redistributions in binary form must reproduce the above copyright
|
|
.\" notice, this list of conditions and the following disclaimer in the
|
|
.\" documentation and/or other materials provided with the distribution.
|
|
.\" 3. Neither the name of the University nor the names of its contributors
|
|
.\" may be used to endorse or promote products derived from this software
|
|
.\" without specific prior written permission.
|
|
.\"
|
|
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
|
|
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
|
|
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
|
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
|
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
|
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
|
.\" SUCH DAMAGE.
|
|
.\"
|
|
.\" @(#)atexit.3 8.1 (Berkeley) 6/4/93
|
|
.\" $FreeBSD$
|
|
.\"
|
|
.Dd September 6, 2002
|
|
.Dt ATEXIT 3
|
|
.Os
|
|
.Sh NAME
|
|
.Nm atexit
|
|
.Nd register a function to be called on exit
|
|
.Sh LIBRARY
|
|
.Lb libc
|
|
.Sh SYNOPSIS
|
|
.In stdlib.h
|
|
.Ft int
|
|
.Fn atexit "void (*function)(void)"
|
|
.Ft int
|
|
.Fn atexit_b "void (^function)(void)"
|
|
.Sh DESCRIPTION
|
|
The
|
|
.Fn atexit
|
|
function
|
|
registers the given
|
|
.Fa function
|
|
to be called at program exit, whether via
|
|
.Xr exit 3
|
|
or via return from the program's
|
|
.Fn main .
|
|
Functions so registered are called in reverse order;
|
|
no arguments are passed.
|
|
.Pp
|
|
These functions must not call
|
|
.Fn exit ;
|
|
if it should be necessary to terminate the process while in such a
|
|
function, the
|
|
.Xr _exit 2
|
|
function should be used.
|
|
(Alternatively, the function may cause abnormal
|
|
process termination, for example by calling
|
|
.Xr abort 3 . )
|
|
.Pp
|
|
At least 32 functions can always be registered,
|
|
and more are allowed as long as sufficient memory can be allocated.
|
|
.Pp
|
|
The
|
|
.Fn atexit_b
|
|
function behaves identically to
|
|
.Fn atexit ,
|
|
except that it takes a block, rather than a function pointer.
|
|
.\" XXX {ATEXIT_MAX} is not implemented yet
|
|
.Sh RETURN VALUES
|
|
.Rv -std atexit
|
|
.Sh ERRORS
|
|
.Bl -tag -width Er
|
|
.It Bq Er ENOMEM
|
|
No memory was available to add the function to the list.
|
|
The existing list of functions is unmodified.
|
|
.It Bq Er ENOSYS
|
|
The
|
|
.Fn atexit_b
|
|
function was called by a program that did not supply a
|
|
.Fn _Block_copy
|
|
implementation.
|
|
.El
|
|
.Sh SEE ALSO
|
|
.Xr at_quick_exit 3 ,
|
|
.Xr exit 3
|
|
.Sh STANDARDS
|
|
The
|
|
.Fn atexit
|
|
function
|
|
conforms to
|
|
.St -isoC .
|