xref: /minix/lib/libc/stdio/fclose.3 (revision 83ee113e)
1.\"	$NetBSD: fclose.3,v 1.9 2003/08/07 16:43:21 agc Exp $
2.\"
3.\" Copyright (c) 1990, 1991, 1993
4.\"	The Regents of the University of California.  All rights reserved.
5.\"
6.\" This code is derived from software contributed to Berkeley by
7.\" Chris Torek and the American National Standards Committee X3,
8.\" on Information Processing Systems.
9.\"
10.\" Redistribution and use in source and binary forms, with or without
11.\" modification, are permitted provided that the following conditions
12.\" are met:
13.\" 1. Redistributions of source code must retain the above copyright
14.\"    notice, this list of conditions and the following disclaimer.
15.\" 2. Redistributions in binary form must reproduce the above copyright
16.\"    notice, this list of conditions and the following disclaimer in the
17.\"    documentation and/or other materials provided with the distribution.
18.\" 3. Neither the name of the University nor the names of its contributors
19.\"    may be used to endorse or promote products derived from this software
20.\"    without specific prior written permission.
21.\"
22.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32.\" SUCH DAMAGE.
33.\"
34.\"     @(#)fclose.3	8.1 (Berkeley) 6/4/93
35.\"
36.Dd June 4, 1993
37.Dt FCLOSE 3
38.Os
39.Sh NAME
40.Nm fclose
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.Sh DESCRIPTION
49The
50.Fn fclose
51function
52dissociates the named
53.Fa stream
54from its underlying file or set of functions.
55If the stream was being used for output, any buffered data is written
56first, using
57.Xr fflush 3 .
58.Sh RETURN VALUES
59Upon successful completion 0 is returned.
60Otherwise,
61.Dv EOF
62is returned and the global variable
63.Va errno
64is set to indicate the error.
65In either case no further access to the stream is possible.
66.Sh ERRORS
67.Bl -tag -width Er
68.It Bq Er EBADF
69The argument
70.Fa stream
71is not an open stream.
72.El
73.Pp
74The
75.Fn fclose
76function
77may also fail and set
78.Va errno
79for any of the errors specified for the routines
80.Xr close 2
81or
82.Xr fflush 3 .
83.Sh SEE ALSO
84.Xr close 2 ,
85.Xr fflush 3 ,
86.Xr fopen 3 ,
87.Xr setbuf 3
88.Sh STANDARDS
89The
90.Fn fclose
91function
92conforms to
93.St -ansiC .
94