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

   1 '\" te
   2 .\"  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 FREOPEN 3C "Jul 24, 2002"
  11 .SH NAME
  12 freopen \- open a stream
  13 .SH SYNOPSIS
  14 .LP
  15 .nf
  16 #include <stdio.h>
  17
  18 \fBFILE *\fR\fBfreopen\fR(\fBconst char *\fR\fIfilename\fR, \fBconst char *\fR\fImode\fR, \fBFILE *\fR\fIstream\fR);
  19 .fi
  20
  21 .SH DESCRIPTION
  22 .LP
  23 The \fBfreopen()\fR function first attempts to flush the stream and close any
  24 file descriptor associated with \fIstream\fR. Failure to flush or close the
  25 file successfully is ignored. The error and end-of-file indicators for the
  26 stream are cleared.
  27 .sp
  28 .LP
  29 The \fBfreopen()\fR function opens the file whose pathname is the string
  30 pointed to by \fIfilename\fR and associates the stream pointed to by
  31 \fIstream\fR with it. The \fImode\fR argument is used just as in
  32 \fBfopen\fR(3C).
  33 .sp
  34 .LP
  35 If \fIfilename\fR is a null pointer and the application conforms to SUSv3 (see
  36 \fBstandards\fR(5)), the \fBfreopen()\fR function attempts to change the mode
  37 of the stream to that specified by \fImode\fR, as though the name of the file
  38 currently associated with the \fIstream\fR had been used.  The following
  39 changes of mode are permitted, depending upon the access mode of the file
  40 descriptor underlying the stream:
  41 .RS +4
  42 .TP
  43 .ie t \(bu
  44 .el o
  45 When \fB+\fR is specified, the file descriptor mode must be \fBO_RDWR\fR.
  46 .RE
  47 .RS +4
  48 .TP
  49 .ie t \(bu
  50 .el o
  51 When \fBr\fR is specified, the file descriptor mode must be \fBO_RDONLY\fR or
  52 \fBO_RDWR\fR.
  53 .RE
  54 .RS +4
  55 .TP
  56 .ie t \(bu
  57 .el o
  58 When \fBa\fR or \fBw\fR is specified, the file descriptor mode must be
  59 \fBO_WRONLY\fR or \fBO_RDWR\fR.
  60 .RE
  61 .sp
  62 .LP
  63 If the filename is a null pointer and the application does not conform to
  64 SUSv3, \fBfreopen()\fR returns a null pointer.
  65 .sp
  66 .LP
  67 The original stream is closed regardless of whether the subsequent open
  68 succeeds.
  69 .sp
  70 .LP
  71 After a successful call to the \fBfreopen()\fR function, the orientation of the
  72 stream is cleared, the encoding rule is cleared, and the associated
  73 \fBmbstate_t\fR object is set to describe an initial conversion state.
  74 .sp
  75 .LP
  76 The largest value that can be represented correctly in an object of type
  77 \fBoff_t\fR will be established as the offset maximum in the open file
  78 description.
  79 .SH RETURN VALUES
  80 .LP
  81 Upon successful completion, \fBfreopen()\fR returns the value of \fIstream\fR.
  82 Otherwise, a null pointer is returned and \fBerrno\fR is set to indicate the
  83 error.
  84 .SH ERRORS
  85 .LP
  86 The \fBfreopen()\fR function will fail if:
  87 .sp
  88 .ne 2
  89 .na
  90 \fB\fBEACCES\fR\fR
  91 .ad
  92 .RS 16n
  93 Search permission is denied on a component of the path prefix, or the file
  94 exists and the permissions specified by \fImode\fR are denied, or the file does
  95 not exist and write permission is denied for the parent directory of the file
  96 to be created.
  97 .RE
  98
  99 .sp
 100 .ne 2
 101 .na
 102 \fB\fBEBADF\fR\fR
 103 .ad
 104 .RS 16n
 105 The application conforms to SUSv3, the \fIfilename\fR argument is a null
 106 pointer, and either the underlying file descriptor is not valid or the mode
 107 specified when the underlying file descriptor was opened does not support the
 108 file access modes requested by the \fImode\fR argument.
 109 .RE
 110
 111 .sp
 112 .ne 2
 113 .na
 114 \fB\fBEFAULT\fR\fR
 115 .ad
 116 .RS 16n
 117 The application does not conform to SUSv3 and the \fIfilename\fR argument is a
 118 null pointer.
 119 .RE
 120
 121 .sp
 122 .ne 2
 123 .na
 124 \fB\fBEINTR\fR\fR
 125 .ad
 126 .RS 16n
 127 A signal was caught during \fBfreopen()\fR.
 128 .RE
 129
 130 .sp
 131 .ne 2
 132 .na
 133 \fB\fBEISDIR\fR\fR
 134 .ad
 135 .RS 16n
 136 The named file is a directory and \fImode\fR requires write access.
 137 .RE
 138
 139 .sp
 140 .ne 2
 141 .na
 142 \fB\fBELOOP\fR\fR
 143 .ad
 144 .RS 16n
 145 Too many symbolic links were encountered in resolving \fIpath\fR.
 146 .RE
 147
 148 .sp
 149 .ne 2
 150 .na
 151 \fB\fBEMFILE\fR\fR
 152 .ad
 153 .RS 16n
 154 There are {\fBOPEN_MAX\fR} file descriptors currently open in the calling
 155 process.
 156 .RE
 157
 158 .sp
 159 .ne 2
 160 .na
 161 \fB\fBENAMETOOLONG\fR\fR
 162 .ad
 163 .RS 16n
 164 The length of the \fIfilename\fR exceeds {\fIPATH_MAX\fR} or a pathname
 165 component is longer than {\fINAME_MAX\fR}.
 166 .RE
 167
 168 .sp
 169 .ne 2
 170 .na
 171 \fB\fBENFILE\fR\fR
 172 .ad
 173 .RS 16n
 174 The maximum allowable number of files is currently open in the system.
 175 .RE
 176
 177 .sp
 178 .ne 2
 179 .na
 180 \fB\fBENOENT\fR\fR
 181 .ad
 182 .RS 16n
 183 A component of \fIfilename\fR does not name an existing file or \fIfilename\fR
 184 is an empty string.
 185 .RE
 186
 187 .sp
 188 .ne 2
 189 .na
 190 \fB\fBENOSPC\fR\fR
 191 .ad
 192 .RS 16n
 193 The directory or file system that would contain the new file cannot be
 194 expanded, the file does not exist, and it was to be created.
 195 .RE
 196
 197 .sp
 198 .ne 2
 199 .na
 200 \fB\fBENOTDIR\fR\fR
 201 .ad
 202 .RS 16n
 203 A component of the path prefix is not a directory.
 204 .RE
 205
 206 .sp
 207 .ne 2
 208 .na
 209 \fB\fBENXIO\fR\fR
 210 .ad
 211 .RS 16n
 212 The named file is a character special or block special file, and the device
 213 associated with this special file does not exist.
 214 .RE
 215
 216 .sp
 217 .ne 2
 218 .na
 219 \fB\fBEOVERFLOW\fR\fR
 220 .ad
 221 .RS 16n
 222 The current value of the file position cannot be represented correctly in an
 223 object of type \fBoff_t\fR.
 224 .RE
 225
 226 .sp
 227 .ne 2
 228 .na
 229 \fB\fBEROFS\fR\fR
 230 .ad
 231 .RS 16n
 232 The named file resides on a read-only file system and \fImode\fR requires write
 233 access.
 234 .RE
 235
 236 .sp
 237 .LP
 238 The \fBfreopen()\fR function may fail if:
 239 .sp
 240 .ne 2
 241 .na
 242 \fB\fBEINVAL\fR\fR
 243 .ad
 244 .RS 16n
 245 The value of the \fImode\fR argument is not valid.
 246 .RE
 247
 248 .sp
 249 .ne 2
 250 .na
 251 \fB\fBENAMETOOLONG\fR\fR
 252 .ad
 253 .RS 16n
 254 Pathname resolution of a symbolic link produced an intermediate result whose
 255 length exceeds {\fIPATH_MAX\fR}.
 256 .RE
 257
 258 .sp
 259 .ne 2
 260 .na
 261 \fB\fBENOMEM\fR\fR
 262 .ad
 263 .RS 16n
 264 Insufficient storage space is available.
 265 .RE
 266
 267 .sp
 268 .ne 2
 269 .na
 270 \fB\fBENXIO\fR\fR
 271 .ad
 272 .RS 16n
 273 A request was made of a non-existent device, or the request was outside the
 274 capabilities of the device.
 275 .RE
 276
 277 .sp
 278 .ne 2
 279 .na
 280 \fB\fBETXTBSY\fR\fR
 281 .ad
 282 .RS 16n
 283 The file is a pure procedure (shared text) file that is being executed and
 284 \fImode\fR requires write access.
 285 .RE
 286
 287 .SH USAGE
 288 .LP
 289 The \fBfreopen()\fR function is typically used to attach the preopened
 290 \fIstreams\fR associated with \fBstdin\fR, \fBstdout\fR and \fBstderr\fR to
 291 other files. By default \fBstderr\fR is unbuffered, but the use of
 292 \fBfreopen()\fR will cause it to become buffered or line-buffered.
 293 .sp
 294 .LP
 295 The \fBfreopen()\fR function has a transitional interface for 64-bit file
 296 offsets.  See \fBlf64\fR(5).
 297 .SH ATTRIBUTES
 298 .LP
 299 See \fBattributes\fR(5) for descriptions of the following attributes:
 300 .sp
 301
 302 .sp
 303 .TS
 304 box;
 305 c | c
 306 l | l .
 307 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 308 _
 309 Interface Stability     Standard
 310 _
 311 MT-Level        MT-Safe
 312 .TE
 313
 314 .SH SEE ALSO
 315 .LP
 316 \fBfclose\fR(3C), \fBfdopen\fR(3C), \fBfopen\fR(3C), \fBstdio\fR(3C),
 317 \fBattributes\fR(5), \fBlf64\fR(5), \fBstandards\fR(5)