xref: /netbsd-src/lib/libc/stdio/fclose.3 (revision 2a399c6883d870daece976daec6ffa7bb7f934ce)
1.\"	$NetBSD: fclose.3,v 1.4 1995/02/02 01:15:33 jtc 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. All advertising materials mentioning features or use of this software
19.\"    must display the following acknowledgement:
20.\"	This product includes software developed by the University of
21.\"	California, Berkeley and its contributors.
22.\" 4. Neither the name of the University nor the names of its contributors
23.\"    may be used to endorse or promote products derived from this software
24.\"    without specific prior written permission.
25.\"
26.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
27.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
28.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
29.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
30.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
31.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
32.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
33.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
34.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
35.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
36.\" SUCH DAMAGE.
37.\"
38.\"     @(#)fclose.3	8.1 (Berkeley) 6/4/93
39.\"
40.Dd June 4, 1993
41.Dt FCLOSE 3
42.Os
43.Sh NAME
44.Nm fclose
45.Nd close a stream
46.Sh SYNOPSIS
47.Fd #include <stdio.h>
48.Ft int
49.Fn fclose "FILE *stream"
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.Sh RETURN VALUES
61Upon successful completion 0 is returned.
62Otherwise,
63.Dv EOF
64is returned and the global variable
65.Va errno
66is set to indicate the error.
67In either case no further access to the stream is possible.
68.Sh ERRORS
69.Bl -tag -width Er
70.It Bq Er EBADF
71The argument
72.Fa stream
73is not an open stream.
74.El
75.Pp
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 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