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