lib/libcr/stdio/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 .\" 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 .\" $FreeBSD: src/lib/libc/stdio/fclose.3,v 1.7.2.4 2001/12/14 18:33:57 ru Exp $
  38 .\" $DragonFly: src/lib/libcr/stdio/Attic/fclose.3,v 1.3 2004/03/11 12:28:51 hmp Exp $
  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 LIBRARY
  47 .Lb libc
  48 .Sh SYNOPSIS
  49 .In stdio.h
  50 .Ft int
  51 .Fn fclose "FILE *stream"
  52 .Sh DESCRIPTION
  53 The
  54 .Fn fclose
  55 function
  56 dissociates the named
  57 .Fa stream
  58 from its underlying file or set of functions.
  59 If the stream was being used for output, any buffered data is written
  60 first, using
  61 .Xr fflush 3 .
  62 .Sh RETURN VALUES
  63 Upon successful completion 0 is returned.
  64 Otherwise,
  65 .Dv EOF
  66 is returned and the global variable
  67 .Va errno
  68 is set to indicate the error.
  69 In either case no further access to the stream is possible.
  70 .Sh ERRORS
  71 The
  72 .Fn fclose
  73 function
  74 may also fail and set
  75 .Va errno
  76 for any of the errors specified for the routines
  77 .Xr close 2
  78 or
  79 .Xr fflush 3 .
  80 .Sh NOTES
  81 .Fn fclose
  82 does not handle NULL arguments; they will result in a segmentation
  83 violation.
  84 This is intentional - it makes it easier to make sure programs written
  85 under
  86 .Dx
  87 are bug free.
  88 This behaviour is an implementation detail, and programs should not
  89 rely upon it.
  90 .Sh SEE ALSO
  91 .Xr close 2 ,
  92 .Xr fflush 3 ,
  93 .Xr fopen 3 ,
  94 .Xr setbuf 3
  95 .Sh STANDARDS
  96 The
  97 .Fn fclose
  98 function
  99 conforms to
 100 .St -isoC .