xref: /freebsd/lib/libc/stdio/fclose.3 (revision 817420dc8eac7df799c78f5309b75092b7f7cd40)
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 LIBRARY
46.Lb libc
47.Sh SYNOPSIS
48.Fd #include <stdio.h>
49.Ft int
50.Fn fclose "FILE *stream"
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.Sh RETURN VALUES
62Upon successful completion 0 is returned.
63Otherwise,
64.Dv EOF
65is returned and the global variable
66.Va errno
67is set to indicate the error.
68In either case no further access to the stream is possible.
69.Sh ERRORS
70The
71.Fn fclose
72function
73may also fail and set
74.Va errno
75for any of the errors specified for the routines
76.Xr close 2
77or
78.Xr fflush 3 .
79.Sh NOTES
80.Fn fclose
81does not handle NULL arguments; they will result in a segmentation
82violation.
83This is intentional - it makes it easier to make sure programs written
84under
85.Fx
86are bug free.
87This behaviour is an implementation detail, and programs should not
88rely upon it.
89.Sh SEE ALSO
90.Xr close 2 ,
91.Xr fflush 3 ,
92.Xr fopen 3 ,
93.Xr setbuf 3
94.Sh STANDARDS
95The
96.Fn fclose
97function
98conforms to
99.St -ansiC .
100