xref: /freebsd/lib/libc/stdlib/at_quick_exit.3 (revision 5ca8e32633c4ffbbcd6762e5888b6a4ba0708c6c)
1.\"  Copyright (c) 2011 David Chisnall
2.\"  All rights reserved.
3.\"
4.\"  Redistribution and use in source and binary forms, with or without
5.\"  modification, are permitted provided that the following conditions
6.\"  are met:
7.\"  1. Redistributions of source code must retain the above copyright
8.\"     notice, this list of conditions and the following disclaimer.
9.\"  2. Redistributions in binary form must reproduce the above copyright
10.\"     notice, this list of conditions and the following disclaimer in the
11.\"     documentation and/or other materials provided with the distribution.
12.\"
13.\"  THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14.\"  ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15.\"  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16.\"  ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17.\"  FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18.\"  DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19.\"  OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20.\"  HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21.\"  LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22.\"  OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23.\"  SUCH DAMAGE.
24.\"
25.Dd December 7, 2011
26.Dt AT_QUICK_EXIT 3
27.Os
28.Sh NAME
29.Nm at_quick_exit
30.Nd registers a cleanup function to run on quick exit
31.Sh LIBRARY
32.Lb libc
33.Sh SYNOPSIS
34.In stdlib.h
35.Ft int
36.Fn at_quick_exit "void (*func)(void)"
37.Sh DESCRIPTION
38The
39.Fn at_quick_exit
40function registers a cleanup function to be called when the program exits as a
41result of calling
42.Xr quick_exit 3 .
43The cleanup functions are called in the reverse order and will not be called if
44the program exits by calling
45.Xr exit 3 ,
46.Xr _Exit 3 ,
47or
48.Xr abort 3 .
49.Sh RETURN VALUES
50The
51.Fn at_quick_exit
52function returns the value 0 if successful and a non-zero value on failure.
53.Sh SEE ALSO
54.Xr exit 3 ,
55.Xr quick_exit 3
56.Sh STANDARDS
57The
58.Fn at_quick_exit
59function conforms to
60.St -isoC-2011 .
61