[dragonfly.git] / lib / libc / stdlib / at_quick_exit.3

.\"  Copyright (c) 2011 David Chisnall
.\"  All rights reserved.
.\"
.\"  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.
.\"
.\"  THIS SOFTWARE IS PROVIDED BY THE AUTHOR 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 AUTHOR 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.
.\"
.\"  $FreeBSD: src/lib/libc/stdlib/at_quick_exit.3,v 1.4 2012/07/26 12:04:11 pluknet Exp $
.\"
.Dd August 9, 2012
.Dt AT_QUICK_EXIT 3
.Os
.Sh NAME
.Nm at_quick_exit
.Nd registers a cleanup function to run on quick exit
.Sh LIBRARY
.Lb libc
.Sh SYNOPSIS
.In stdlib.h
.Ft int
.Fn at_quick_exit "void (*func)(void)"
.Sh DESCRIPTION
The
.Fn at_quick_exit
function registers a cleanup function to be called when the program exits as a
result of calling
.Xr quick_exit 3 .
The cleanup functions are called in the reverse order and will not be called if
the program exits by calling
.Xr exit 3 ,
.Xr _Exit 3 ,
or
.Xr abort 3 .
.Sh RETURN VALUES
The
.Fn at_quick_exit
function returns the value 0 if successful and a non-zero value on failure.
.Sh ERRORS
The function is registered unless:
.Bl -tag -width Er
.It Bq Er ENOMEM
An allocation to register the function failed.
.El
.Sh SEE ALSO
.Xr exit 3 ,
.Xr quick_exit 3
.Sh STANDARDS
The
.Fn at_quick_exit
function conforms to
.St -isoC-2011 .
Commit	Line	Data
f3adbb3c SW	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	.\" $FreeBSD: src/lib/libc/stdlib/at_quick_exit.3,v 1.4 2012/07/26 12:04:11 pluknet Exp $
	26	.\"
	27	.Dd August 9, 2012
	28	.Dt AT_QUICK_EXIT 3
	29	.Os
	30	.Sh NAME
	31	.Nm at_quick_exit
	32	.Nd registers a cleanup function to run on quick exit
	33	.Sh LIBRARY
	34	.Lb libc
	35	.Sh SYNOPSIS
	36	.In stdlib.h
	37	.Ft int
	38	.Fn at_quick_exit "void (*func)(void)"
	39	.Sh DESCRIPTION
	40	The
	41	.Fn at_quick_exit
	42	function registers a cleanup function to be called when the program exits as a
	43	result of calling
	44	.Xr quick_exit 3 .
	45	The cleanup functions are called in the reverse order and will not be called if
	46	the program exits by calling
	47	.Xr exit 3 ,
	48	.Xr _Exit 3 ,
	49	or
	50	.Xr abort 3 .
	51	.Sh RETURN VALUES
	52	The
	53	.Fn at_quick_exit
	54	function returns the value 0 if successful and a non-zero value on failure.
faf683e3 SW	55	.Sh ERRORS
	56	The function is registered unless:
	57	.Bl -tag -width Er
	58	.It Bq Er ENOMEM
	59	An allocation to register the function failed.
	60	.El
f3adbb3c SW	61	.Sh SEE ALSO
	62	.Xr exit 3 ,
	63	.Xr quick_exit 3
	64	.Sh STANDARDS
	65	The
	66	.Fn at_quick_exit
	67	function conforms to
	68	.St -isoC-2011 .