mirror of
https://git.hardenedbsd.org/hardenedbsd/HardenedBSD.git
synced 2024-11-22 11:14:18 +01:00
156 lines
3.9 KiB
Groff
156 lines
3.9 KiB
Groff
.\" Copyright (c) 1990, 1991, 1993 The Regents of the University of California.
|
|
.\" Copyright (c) 2015 Mariusz Zaborski <oshogbo@FreeBSD.org>
|
|
.\" 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.
|
|
.\"
|
|
.Dd February 13, 2024
|
|
.Dt FCLOSE 3
|
|
.Os
|
|
.Sh NAME
|
|
.Nm fclose ,
|
|
.Nm fdclose ,
|
|
.Nm fcloseall
|
|
.Nd close a stream
|
|
.Sh LIBRARY
|
|
.Lb libc
|
|
.Sh SYNOPSIS
|
|
.In stdio.h
|
|
.Ft int
|
|
.Fn fclose "FILE *stream"
|
|
.Ft int
|
|
.Fn fdclose "FILE *stream" "int *fdp"
|
|
.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 fdclose
|
|
function is equivalent to
|
|
.Fn fclose
|
|
except that it does not close the underlying file descriptor.
|
|
If
|
|
.Fa fdp
|
|
is not
|
|
.Dv NULL ,
|
|
the file descriptor will be written to it.
|
|
If the stream does not have an associated file descriptor,
|
|
.Fa fdp
|
|
will be set to -1.
|
|
This type of stream is created with functions such as
|
|
.Xr fmemopen 3 ,
|
|
.Xr funopen 3 ,
|
|
or
|
|
.Xr open_memstream 3 .
|
|
.Pp
|
|
The
|
|
.Fn fcloseall
|
|
function calls
|
|
.Fn fclose
|
|
on all open streams.
|
|
.Sh RETURN VALUES
|
|
.Fn fcloseall
|
|
does not return a value.
|
|
.Pp
|
|
Upon successful completion the
|
|
.Fn fclose
|
|
and
|
|
.Fn fdclose
|
|
functions return 0.
|
|
Otherwise,
|
|
.Dv EOF
|
|
is returned and the global variable
|
|
.Va errno
|
|
is set to indicate the error.
|
|
.Sh ERRORS
|
|
.Fn fdclose
|
|
fails if:
|
|
.Bl -tag -width Er
|
|
.It Bq Er EOPNOTSUPP
|
|
The stream does not have an associated file descriptor.
|
|
.El
|
|
.Pp
|
|
The
|
|
.Fn fclose
|
|
and
|
|
.Fn fdclose
|
|
functions may also fail and set
|
|
.Va errno
|
|
for any of the errors specified for
|
|
.Xr fflush 3 .
|
|
.Pp
|
|
The
|
|
.Fn fclose
|
|
function may also fail and set errno for any of the errors specified for
|
|
.Xr close 2 .
|
|
.Sh NOTES
|
|
The
|
|
.Fn fclose
|
|
and
|
|
.Fn fdclose
|
|
functions do not handle NULL arguments in the
|
|
.Fa stream
|
|
variable; this 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 .
|
|
.Sh HISTORY
|
|
The
|
|
.Fn fcloseall
|
|
function first appeared in
|
|
.Fx 7.0 .
|
|
.Pp
|
|
The
|
|
.Fn fdclose
|
|
function first appeared in
|
|
.Fx 11.0 .
|