xref: /dragonfly/lib/libc/stdio/fclose.3 (revision ed36d35d)
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.\" 3. 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: src/lib/libc/stdio/fclose.3,v 1.15 2007/01/09 00:28:06 imp Exp $
34.\" $DragonFly: src/lib/libc/stdio/fclose.3,v 1.4 2004/06/07 16:37:56 hmp Exp $
35.\"
36.Dd April 22, 2006
37.Dt FCLOSE 3
38.Os
39.Sh NAME
40.Nm fclose ,
41.Nm fcloseall
42.Nd close a stream
43.Sh LIBRARY
44.Lb libc
45.Sh SYNOPSIS
46.In stdio.h
47.Ft int
48.Fn fclose "FILE *stream"
49.Ft void
50.Fn fcloseall void
51.Sh DESCRIPTION
52The
53.Fn fclose
54function
55dissociates the named
56.Fa stream
57from its underlying file or set of functions.
58If the stream was being used for output, any buffered data is written
59first, using
60.Xr fflush 3 .
61.Pp
62The
63.Fn fcloseall
64function calls
65.Fn fclose
66on all open streams.
67.Sh RETURN VALUES
68Upon successful completion 0 is returned.
69Otherwise,
70.Dv EOF
71is returned and the global variable
72.Va errno
73is set to indicate the error.
74In either case no further access to the stream is possible.
75.Sh ERRORS
76The
77.Fn fclose
78function
79may also fail and set
80.Va errno
81for any of the errors specified for the routines
82.Xr close 2
83or
84.Xr fflush 3 .
85.Sh NOTES
86The
87.Fn fclose
88function
89does not handle NULL arguments; they will result in a segmentation
90violation.
91This is intentional - it makes it easier to make sure programs written
92under
93.Dx
94are bug free.
95This behaviour is an implementation detail, and programs should not
96rely upon it.
97.Sh SEE ALSO
98.Xr close 2 ,
99.Xr fflush 3 ,
100.Xr fopen 3 ,
101.Xr setbuf 3
102.Sh STANDARDS
103The
104.Fn fclose
105function
106conforms to
107.St -isoC .
108.Pp
109The
110.Fn fcloseall
111function first appeared in
112.Dx 2.3 .
113