usr/src/man/man3c/fclose.3c

   1 '\" te
   2 .\" Copyright 1989 AT&T.  Copyright (c) 2002, Sun Microsystems, Inc.  All Rights Reserved.  Portions Copyright (c) 1992, X/Open Company Limited.  All Rights Reserved.
   3 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at
   4 .\" http://www.opengroup.org/bookstore/.
   5 .\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html.
   6 .\"  This notice shall appear on any product containing this material.
   7 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   8 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   9 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
  10 .TH FCLOSE 3C "Nov 1, 2003"
  11 .SH NAME
  12 fclose \- close a stream
  13 .SH SYNOPSIS
  14 .LP
  15 .nf
  16 #include <stdio.h>
  17
  18 \fBint\fR \fBfclose\fR(\fBFILE *\fR\fIstream\fR);
  19 .fi
  20
  21 .SH DESCRIPTION
  22 .LP
  23 The \fBfclose()\fR function causes the stream pointed to by \fIstream\fR to be
  24 flushed and the associated file to be closed. Any unwritten buffered data for
  25 the stream is written to the file; any unread buffered data is discarded. The
  26 stream is disassociated from the file. If the associated buffer was
  27 automatically allocated, it is deallocated.
  28 .sp
  29 .LP
  30 The \fBfclose()\fR function marks for update the \fBst_ctime\fR and
  31 \fBst_mtime\fR fields of the underlying file if the stream is writable and if
  32 buffered data has not yet been written to the file.  It will perform a
  33 \fBclose\fR(2) operation on the file descriptor that is associated with the
  34 stream pointed to by \fIstream\fR.
  35 .sp
  36 .LP
  37 After the call to \fBfclose()\fR, any use of \fIstream\fR causes undefined
  38 behavior.
  39 .sp
  40 .LP
  41 The \fBfclose()\fR function is performed automatically for all open files upon
  42 calling \fBexit\fR(2).
  43 .SH RETURN VALUES
  44 .LP
  45 Upon successful completion, \fBfclose()\fR returns \fB0\fR. Otherwise, it
  46 returns \fBEOF\fR and sets \fBerrno\fR to indicate the error.
  47 .SH ERRORS
  48 .LP
  49 The \fBfclose()\fR function will fail if:
  50 .sp
  51 .ne 2
  52 .na
  53 \fB\fBEAGAIN\fR\fR
  54 .ad
  55 .RS 10n
  56 The \fBO_NONBLOCK\fR flag is set for the file descriptor underlying
  57 \fIstream\fR and the process would be delayed in the write operation.
  58 .RE
  59
  60 .sp
  61 .ne 2
  62 .na
  63 \fB\fBEBADF\fR\fR
  64 .ad
  65 .RS 10n
  66 The file descriptor underlying stream is not valid.
  67 .RE
  68
  69 .sp
  70 .ne 2
  71 .na
  72 \fB\fBEFBIG\fR\fR
  73 .ad
  74 .RS 10n
  75 An attempt was made to write a file that exceeds the maximum file size or the
  76 process's file size limit; or the file is a regular file and an attempt was
  77 made to write at or beyond the offset maximum associated with the corresponding
  78 stream.
  79 .RE
  80
  81 .sp
  82 .ne 2
  83 .na
  84 \fB\fBEINTR\fR\fR
  85 .ad
  86 .RS 10n
  87 The \fBfclose()\fR function was interrupted by a signal.
  88 .RE
  89
  90 .sp
  91 .ne 2
  92 .na
  93 \fB\fBEIO\fR\fR
  94 .ad
  95 .RS 10n
  96 The process is a member of a background process group attempting to write to
  97 its controlling terminal, \fBTOSTOP\fR is set, the process is neither ignoring
  98 nor blocking \fBSIGTTOU\fR and the process group of the process is orphaned.
  99 .RE
 100
 101 .sp
 102 .ne 2
 103 .na
 104 \fB\fBENOSPC\fR\fR
 105 .ad
 106 .RS 10n
 107 There was no free space remaining on the device containing the file.
 108 .RE
 109
 110 .sp
 111 .ne 2
 112 .na
 113 \fB\fBEPIPE\fR\fR
 114 .ad
 115 .RS 10n
 116 An attempt is made to write to a pipe or \fBFIFO\fR that is not open for
 117 reading by any process. A \fBSIGPIPE\fR signal will also be sent to the calling
 118 thread.
 119 .RE
 120
 121 .sp
 122 .LP
 123 The \fBfclose()\fR function may fail if:
 124 .sp
 125 .ne 2
 126 .na
 127 \fB\fBENXIO\fR\fR
 128 .ad
 129 .RS 9n
 130 A request was made of a non-existent device, or the request was beyond the
 131 limits of the device.
 132 .RE
 133
 134 .SH ATTRIBUTES
 135 .LP
 136 See \fBattributes\fR(5) for descriptions of the following attributes:
 137 .sp
 138
 139 .sp
 140 .TS
 141 box;
 142 c | c
 143 l | l .
 144 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 145 _
 146 Interface Stability     Standard
 147 _
 148 MT-Level        MT-Safe
 149 .TE
 150
 151 .SH SEE ALSO
 152 .LP
 153 \fBclose\fR(2), \fBexit\fR(2), \fBgetrlimit\fR(2), \fBulimit\fR(2),
 154 \fBfcloseall\fR(3C), \fBfopen\fR(3C), \fBstdio\fR(3C),
 155 \fBattributes\fR(5), \fBstandards\fR(5)