stdio/FreeBSD/fclose.3

   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 .\" 4. Neither the name of the University nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\"     @(#)fclose.3    8.1 (Berkeley) 6/4/93
  33 .\" $FreeBSD: src/lib/libc/stdio/fclose.3,v 1.15 2007/01/09 00:28:06 imp Exp $
  34 .\"
  35 .Dd April 22, 2006
  36 .Dt FCLOSE 3
  37 .Os
  38 .Sh NAME
  39 .Nm fclose ,
  40 .Nm fcloseall
  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 .Ft void
  49 .Fn fcloseall void
  50 .Sh DESCRIPTION
  51 The
  52 .Fn fclose
  53 function
  54 dissociates the named
  55 .Fa stream
  56 from its underlying file or set of functions.
  57 If the stream was being used for output, any buffered data is written
  58 first, using
  59 .Xr fflush 3 .
  60 .Pp
  61 The
  62 .Fn fcloseall
  63 function calls
  64 .Fn fclose
  65 on all open streams.
  66 .Sh RETURN VALUES
  67 Upon successful completion 0 is returned.
  68 Otherwise,
  69 .Dv EOF
  70 is returned and the global variable
  71 .Va errno
  72 is set to indicate the error.
  73 In either case no further access to the stream is possible.
  74 .Sh ERRORS
  75 The
  76 .Fn fclose
  77 function
  78 may also fail and set
  79 .Va errno
  80 for any of the errors specified for the routines
  81 .Xr close 2
  82 or
  83 .Xr fflush 3 .
  84 .Sh NOTES
  85 The
  86 .Fn fclose
  87 function
  88 does not handle NULL arguments; they will result in a segmentation
  89 violation.
  90 This is intentional - it makes it easier to make sure programs written
  91 under
  92 .Fx
  93 are bug free.
  94 This behaviour is an implementation detail, and programs should not
  95 rely upon it.
  96 .Sh SEE ALSO
  97 .Xr close 2 ,
  98 .Xr fflush 3 ,
  99 .Xr fopen 3 ,
 100 .Xr setbuf 3
 101 .Sh STANDARDS
 102 The
 103 .Fn fclose
 104 function
 105 conforms to
 106 .St -isoC .
 107 .Pp
 108 The
 109 .Fn fcloseall
 110 function first appeared in
 111 .Fx 7.0 .