xref: /freebsd/lib/libc/stdio/fclose.3 (revision daf1cffce2e07931f27c6c6998652e90df6ba87e)
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. All advertising materials mentioning features or use of this software
17.\"    must display the following acknowledgement:
18.\"	This product includes software developed by the University of
19.\"	California, Berkeley and its contributors.
20.\" 4. Neither the name of the University nor the names of its contributors
21.\"    may be used to endorse or promote products derived from this software
22.\"    without specific prior written permission.
23.\"
24.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
25.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
28.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
30.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
31.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
33.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34.\" SUCH DAMAGE.
35.\"
36.\"     @(#)fclose.3	8.1 (Berkeley) 6/4/93
37.\" $FreeBSD$
38.\"
39.Dd June 4, 1993
40.Dt FCLOSE 3
41.Os
42.Sh NAME
43.Nm fclose
44.Nd close a stream
45.Sh SYNOPSIS
46.Fd #include <stdio.h>
47.Ft int
48.Fn fclose "FILE *stream"
49.Sh DESCRIPTION
50The
51.Fn fclose
52function
53dissociates the named
54.Fa stream
55from its underlying file or set of functions.
56If the stream was being used for output, any buffered data is written
57first, using
58.Xr fflush 3 .
59.Sh RETURN VALUES
60Upon successful completion 0 is returned.
61Otherwise,
62.Dv EOF
63is returned and the global variable
64.Va errno
65is set to indicate the error.
66In either case no further access to the stream is possible.
67.Sh ERRORS
68The
69.Fn fclose
70function
71may also fail and set
72.Va errno
73for any of the errors specified for the routines
74.Xr close 2
75or
76.Xr fflush 3 .
77.Sh NOTES
78.Fn fclose
79does not handle NULL arguments; they will result in a segmentation
80violation.
81This is intentional - it makes it easier to make sure programs written
82under FreeBSD are bug free.
83This behaviour is an implementation detail, and programs should not
84rely upon it.
85.Sh SEE ALSO
86.Xr close 2 ,
87.Xr fflush 3 ,
88.Xr fopen 3 ,
89.Xr setbuf 3
90.Sh STANDARDS
91The
92.Fn fclose
93function
94conforms to
95.St -ansiC .
96