fclose.3 revision 39923
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.\" 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 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 [EBADF] 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 . 83If passed a NULL argument, 84.Fn fclose 85will dump core. This is intentional, as it makes it easier to make 86sure programs written under FreeBSD are bug free. 87.Sh SEE ALSO 88.Xr close 2 , 89.Xr fflush 3 , 90.Xr fopen 3 , 91.Xr setbuf 3 92.Sh STANDARDS 93The 94.Fn fclose 95function 96conforms to 97.St -ansiC . 98