Index of Section 3 Manual Pages
| Interix / SUA | fopen.3 | Interix / SUA |
fopen(3) fopen(3)
fdopen()
NAME
fopen(), fdopen(), freopen() - stream open functions
SYNOPSIS
#include
FILE * fopen (char *path, const char *mode)
FILE * fdopen (int fd, const char *mode)
FILE * freopen (const char *path, const char *mode, FILE *stream)
DESCRIPTION
The fopen(3) function opens the file whose name is the string pointed to
by path and associates a stream with it.
The argument mode points to a string beginning with one of the following
sequences. Additional characters may follow these sequences.
r
Open text file for reading. The stream is positioned at the beginning
of the file.
r+
Open for reading and writing. The stream is positioned at the
beginning of the file.
w
Truncate file to zero length or create text file for writing. The
stream is positioned at the beginning of the file.
w+
Open for reading and writing. The file is created if it does not
exist, otherwise it is truncated. The stream is positioned at the
beginning of the file.
a
Open for writing. The file is created if it does not exist. The stream
is positioned at the end of the file.
a+
Open for reading and writing. The file is created if it does not
exist. The stream is positioned at the end of the file.
The mode string can also include the letter "b" either as a third
character or as a character between the characters in any of the two-
character strings described above.
Any created files will have mode S_IRUSR | S_IWUSR | S_IRGRP | S_IWGRP |
S_IROTH | S_IWOTH (0666), as modified by the process' umask value (see
umask(2)).
Reads and writes may be intermixed on read/write streams in any order, and
do not require an intermediate seek as in previous versions of stdio. This
is not portable to other systems, however; ANSI C requires that a file
positioning function intervene between output and input, unless an input
operation encounters end-of-file.
The fdopen(3) function associates a stream with the existing file
descriptor, fd. The mode of the stream must be compatible with the mode of
the file descriptor.
The freopen(3) function opens the file whose name is the string pointed to
by path and associates the stream pointed to by stream with it. The
original stream (if it exists) is closed. The mode argument is used just
as in the fopen(3) function. The primary use of the freopen(3) function is
to change the file associated with a standard text stream (stderr, stdin,
or stdout).
RETURN VALUES
Upon successful completion fopen(3), fdopen(3), and freopen(3) return a
FILE pointer. Otherwise, NULL is returned and the global variable errno is
set to indicate the error.
ERRORS
[EINVAL]
The mode provided to fopen(3), fdopen(3), or freopen(3) was invalid.
The fopen(3) function may fail and set errno for any of the errors
specified for the routines malloc(3) and open(2). The fdopen(3) function
may fail and set errno for any of the errors specified for the routines
malloc(3) and fcntl(2). The freopen(3) function may also fail and set
errno for any of the errors specified for the routines open(2), fclose(3)
and fflush(3).
SEE ALSO
open(2)
fclose(3)
fflush(3)
fseek(3)
USAGE NOTES
All of these functions are thread safe.
None of these functions are async-signal safe.