xref: /freebsd/lib/libc/stdio/fclose.3 (revision 641a6cfb86023499caafe26a4d821a0b885cf00b)
1.\" Copyright (c) 1990, 1991, 1993
2.\"	The Regents of the University of California.  All rights reserved.
3.\"
4.\" This code is derived from software contributed to Berkeley by
5.\" Chris Torek and the American National Standards Committee X3,
6.\" on Information Processing Systems.
7.\"
8.\" Redistribution and use in source and binary forms, with or without
9.\" modification, are permitted provided that the following conditions
10.\" are met:
11.\" 1. Redistributions of source code must retain the above copyright
12.\"    notice, this list of conditions and the following disclaimer.
13.\" 2. Redistributions in binary form must reproduce the above copyright
14.\"    notice, this list of conditions and the following disclaimer in the
15.\"    documentation and/or other materials provided with the distribution.
16.\" 4. Neither the name of the University nor the names of its contributors
17.\"    may be used to endorse or promote products derived from this software
18.\"    without specific prior written permission.
19.\"
20.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30.\" SUCH DAMAGE.
31.\"
32.\"     @(#)fclose.3	8.1 (Berkeley) 6/4/93
33.\" $FreeBSD$
34.\"
35.Dd April 22, 2006
36.Dt FCLOSE 3
37.Os
38.Sh NAME
39.Nm fclose ,
40.Nm fcloseall
41.Nd close a stream
42.Sh LIBRARY
43.Lb libc
44.Sh SYNOPSIS
45.In stdio.h
46.Ft int
47.Fn fclose "FILE *stream"
48.Ft void
49.Fn fcloseall void
50.Sh DESCRIPTION
51The
52.Fn fclose
53function
54dissociates the named
55.Fa stream
56from its underlying file or set of functions.
57If the stream was being used for output, any buffered data is written
58first, using
59.Xr fflush 3 .
60.Pp
61The
62.Fn fcloseall
63function calls
64.Fn fclose
65on all open streams.
66.Sh RETURN VALUES
67Upon successful completion 0 is returned.
68Otherwise,
69.Dv EOF
70is returned and the global variable
71.Va errno
72is set to indicate the error.
73In either case no further access to the stream is possible.
74.Sh ERRORS
75The
76.Fn fclose
77function
78may also fail and set
79.Va errno
80for any of the errors specified for the routines
81.Xr close 2
82or
83.Xr fflush 3 .
84.Sh NOTES
85The
86.Fn fclose
87function
88does not handle NULL arguments; they will result in a segmentation
89violation.
90This is intentional - it makes it easier to make sure programs written
91under
92.Fx
93are bug free.
94This behaviour is an implementation detail, and programs should not
95rely upon it.
96.Sh SEE ALSO
97.Xr close 2 ,
98.Xr fflush 3 ,
99.Xr fopen 3 ,
100.Xr setbuf 3
101.Sh STANDARDS
102The
103.Fn fclose
104function
105conforms to
106.St -isoC .
107.Pp
108The
109.Fn fcloseall
110function first appeared in
111.Fx 7.0 .
112