xref: /openbsd-src/lib/libc/stdio/fclose.3 (revision b2ea75c1b17e1a9a339660e7ed45cd24946b230e)
1.\"	$OpenBSD: fclose.3,v 1.4 2000/12/24 00:30:57 aaron 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.Dd June 4, 1993
39.Dt FCLOSE 3
40.Os
41.Sh NAME
42.Nm fclose
43.Nd close a stream
44.Sh SYNOPSIS
45.Fd #include <stdio.h>
46.Ft int
47.Fn fclose "FILE *stream"
48.Sh DESCRIPTION
49The
50.Fn fclose
51function dissociates the named
52.Fa stream
53from its underlying file or set of functions.
54If the stream was being used for output, any buffered data is written
55first, using
56.Xr fflush 3 .
57.Sh RETURN VALUES
58Upon successful completion 0 is returned.
59Otherwise,
60.Dv EOF
61is returned and the global variable
62.Va errno
63is set to indicate the error.
64In either case no further access to the stream is possible.
65.Sh ERRORS
66.Bl -tag -width Er
67.It Bq Er EBADF
68The argument
69.Fa stream
70is not an open stream.
71.El
72.Pp
73The
74.Fn fclose
75function may also fail and set
76.Va errno
77for any of the errors specified for the routines
78.Xr close 2
79or
80.Xr fflush 3 .
81.Sh SEE ALSO
82.Xr close 2 ,
83.Xr fflush 3 ,
84.Xr fopen 3 ,
85.Xr setbuf 3
86.Sh STANDARDS
87The
88.Fn fclose
89function conforms to
90.St -ansiC .
91