freebsd-dev/lib/libc/stdio/fclose.3

.\" 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. All advertising materials mentioning features or use of this software
.\"    must display the following acknowledgement:
.\"	This product includes software developed by the University of
.\"	California, Berkeley and its contributors.
.\" 4. 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.
.\"
.\"     @(#)fclose.3	8.1 (Berkeley) 6/4/93
.\" $FreeBSD$
.\"
.Dd June 4, 1993
.Dt FCLOSE 3
.Os
.Sh NAME
.Nm fclose ,
.Nm fcloseall
.Nd close a stream
.Sh LIBRARY
.Lb libc
.Sh SYNOPSIS
.In stdio.h
.Ft int
.Fn fclose "FILE *stream"
.Ft void
.Fn fcloseall void
.Sh DESCRIPTION
The
.Fn fclose
function
dissociates the named
.Fa stream
from its underlying file or set of functions.
If the stream was being used for output, any buffered data is written
first, using
.Xr fflush 3 .
.Pp
The
.Fn fcloseall
function calls
.Fn fclose
on all open streams.
.Sh RETURN VALUES
Upon successful completion 0 is returned.
Otherwise,
.Dv EOF
is returned and the global variable
.Va errno
is set to indicate the error.
In either case no further access to the stream is possible.
.Sh ERRORS
The
.Fn fclose
function
may also fail and set
.Va errno
for any of the errors specified for the routines
.Xr close 2
or
.Xr fflush 3 .
.Sh NOTES
The
.Fn fclose
function
does not handle NULL arguments; they will result in a segmentation
violation.
This is intentional - it makes it easier to make sure programs written
under
.Fx
are bug free.
This behaviour is an implementation detail, and programs should not
rely upon it.
.Sh SEE ALSO
.Xr close 2 ,
.Xr fflush 3 ,
.Xr fopen 3 ,
.Xr setbuf 3
.Sh STANDARDS
The
.Fn fclose
function
conforms to
.St -isoC .
.Pp
The
.Fn fcloseall
function first appeared in
.Fx 7.0 .
Remove the description of EBADF (that's an implementation detail if I ever saw one), and move the description of NULL behaviour out to a 'NOTES' section, with an extra note that programs should not rely up on it. Kinda-approve-by: bde (by not replying to the mail with the diff) 1998-10-10 13:31:32 +00:00			`.\" Copyright (c) 1990, 1991, 1993`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.\" 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. All advertising materials mentioning features or use of this software`
			`.\" must display the following acknowledgement:`
			`.\" This product includes software developed by the University of`
			`.\" California, Berkeley and its contributors.`
			`.\" 4. 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.`
			`.\"`
			`.\" @(#)fclose.3 8.1 (Berkeley) 6/4/93`
$Id$ -> $FreeBSD$ 1999-08-28 00:22:10 +00:00			`.\" $FreeBSD$`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.\"`
			`.Dd June 4, 1993`
			`.Dt FCLOSE 3`
			`.Os`
			`.Sh NAME`
Add fcloseall() to libc. This removes the need to export _cleanup(). Linux also provides an fcloseall() implementation. Discussed on: arch 2006-04-22 15:09:15 +00:00			`.Nm fclose ,`
			`.Nm fcloseall`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Nd close a stream`
Introduce ".Lb" macro to libc manpages. More libraries manpages updates following. 2000-04-21 09:42:15 +00:00			`.Sh LIBRARY`
			`.Lb libc`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Sh SYNOPSIS`
mdoc(7) police: Use the new .In macro for #include statements. 2001-10-01 16:09:29 +00:00			`.In stdio.h`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Ft int`
			`.Fn fclose "FILE *stream"`
Add fcloseall() to libc. This removes the need to export _cleanup(). Linux also provides an fcloseall() implementation. Discussed on: arch 2006-04-22 15:09:15 +00:00			`.Ft void`
			`.Fn fcloseall void`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Sh DESCRIPTION`
			`The`
			`.Fn fclose`
			`function`
			`dissociates the named`
			`.Fa stream`
			`from its underlying file or set of functions.`
			`If the stream was being used for output, any buffered data is written`
			`first, using`
			`.Xr fflush 3 .`
Add fcloseall() to libc. This removes the need to export _cleanup(). Linux also provides an fcloseall() implementation. Discussed on: arch 2006-04-22 15:09:15 +00:00			`.Pp`
			`The`
			`.Fn fcloseall`
			`function calls`
			`.Fn fclose`
			`on all open streams.`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Sh RETURN VALUES`
			`Upon successful completion 0 is returned.`
			`Otherwise,`
			`.Dv EOF`
			`is returned and the global variable`
			`.Va errno`
			`is set to indicate the error.`
			`In either case no further access to the stream is possible.`
Note that dying on NULL is an implementation detail. 1998-12-17 17:13:47 +00:00			`.Sh ERRORS`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`The`
			`.Fn fclose`
			`function`
			`may also fail and set`
			`.Va errno`
			`for any of the errors specified for the routines`
			`.Xr close 2`
			`or`
			`.Xr fflush 3 .`
Remove the description of EBADF (that's an implementation detail if I ever saw one), and move the description of NULL behaviour out to a 'NOTES' section, with an extra note that programs should not rely up on it. Kinda-approve-by: bde (by not replying to the mail with the diff) 1998-10-10 13:31:32 +00:00			`.Sh NOTES`
mdoc(7) police: "The .Fn function". 2002-12-18 12:45:11 +00:00			`The`
Document that we will core-dump on getting a NULL pointer. 1998-09-28 15:34:24 +00:00			`.Fn fclose`
mdoc(7) police: "The .Fn function". 2002-12-18 12:45:11 +00:00			`function`
Note that dying on NULL is an implementation detail. 1998-12-17 17:13:47 +00:00			`does not handle NULL arguments; they will result in a segmentation`
			`violation.`
			`This is intentional - it makes it easier to make sure programs written`
Use Fx macro wherever possible. 2000-11-14 11:20:58 +00:00			`under`
			`.Fx`
			`are bug free.`
Note that dying on NULL is an implementation detail. 1998-12-17 17:13:47 +00:00			`This behaviour is an implementation detail, and programs should not`
			`rely upon it.`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Sh SEE ALSO`
			`.Xr close 2 ,`
			`.Xr fflush 3 ,`
			`.Xr fopen 3 ,`
			`.Xr setbuf 3`
			`.Sh STANDARDS`
			`The`
			`.Fn fclose`
			`function`
			`conforms to`
.St -ansiC -> .St -isoC 2001-02-26 13:23:47 +00:00			`.St -isoC .`
Add fcloseall() to libc. This removes the need to export _cleanup(). Linux also provides an fcloseall() implementation. Discussed on: arch 2006-04-22 15:09:15 +00:00			`.Pp`
			`The`
			`.Fn fcloseall`
			`function first appeared in`
			`.Fx 7.0 .`