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
http://www.opengroup.org/bookstore/.
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 SunOS 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.
This notice shall appear on any product containing this material.
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.
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.
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]
Portions Copyright (c) 1992, X/Open Company Limited. All Rights Reserved.
Copyright (c) 2006, Sun Microsystems, Inc. All Rights Reserved.
#include <stdio.h> FILE *fdopen(int fildes, const char *mode);
The fdopen() function associates a stream with a file descriptor fildes.
The mode argument is a character string having one of the following values:
| r or rb Open a file for reading. |
| w or wb Open a file for writing. |
| a or ab Open a file for writing at end of file. |
| r+, rb+ or r+b |
| Open a file for update (reading and writing). |
| w+, wb+ or w+b |
| Open a file for update (reading and writing). |
| a+, ab+ or a+b |
| Open a file for update (reading and writing) at end of file. |
The meaning of these flags is exactly as specified for the fopen(3C) function, except that modes beginning with w do not cause truncation of the file. A trailing F character can also be included in the mode argument as described in fopen(3C) to enable extended FILE facility.
The mode of the stream must be allowed by the file access mode of the open file. The file position indicator associated with the new stream is set to the position indicated by the file offset associated with the file descriptor.
The fdopen() function preserves the offset maximum previously set for the open file description corresponding to fildes.
The error and end-of-file indicators for the stream are cleared. The fdopen() function may cause the st_atime field of the underlying file to be marked for update.
If fildes refers to a shared memory object, the result of the fdopen() function is unspecified.
Upon successful completion, fdopen() returns a pointer to a stream. Otherwise, a null pointer is returned and errno is set to indicate the error.
The fdopen() function may fail and not set errno if there are no free stdio streams.
The fdopen() function may fail if: EBADF
The fildes argument is not a valid file descriptor.
The mode argument is not a valid mode.
{FOPEN_MAX} streams are currently open in the calling process. {STREAM_MAX} streams are currently open in the calling process.
There is insufficient space to allocate a buffer.
A process is allowed to have at least {FOPEN_MAX} stdio streams open at a time. For 32-bit applications, however, the underlying ABIs formerly required that no file descriptor used to access the file underlying a stdio stream have a value greater than 255. To maintain binary compatibility with earlier Solaris releases, this limit still constrains 32-bit applications.
File descriptors are obtained from calls like open(2), dup(2), creat(2) or pipe(2), which open files but do not return streams. Streams are necessary input for almost all of the standard I/O library functions.
See attributes(5) for descriptions of the following attributes:
| ATTRIBUTE TYPE ATTRIBUTE VALUE |
| Interface Stability See below. |
| MT-Level MT-Safe |
The F character in the mode argument is Evolving. In all other respects this function is Standard.
creat(2), dup(2), open(2), pipe(2), fclose(3C), fopen(3C), attributes(5), standards(5)