NAME

freopen - open a stream

SYNOPSIS

#include <stdio.h>

FILE *freopen(const char *restrict filename, const char *restrict mode,
       FILE *restrict stream);


DESCRIPTION

^[CX] The functionality described on this reference page is aligned with the ISO C standard. Any conflict between the requirements described here and the ISO C standard is unintentional. This volume of IEEE Std 1003.1-2001 defers to the ISO C standard.

The freopen() function shall first attempt to flush the stream and close any file descriptor associated with stream. Failure to flush or close the file descriptor successfully shall be ignored. The error and end-of-file indicators for the stream shall be cleared.

The freopen() function shall open the file whose pathname is the string pointed to by filename and associate the stream pointed to by stream with it. The mode argument shall be used just as in fopen().

The original stream shall be closed regardless of whether the subsequent open succeeds.

If filename is a null pointer, the freopen() function shall attempt to change the mode of the stream to that specified by mode, as if the name of the file currently associated with the stream had been used. In this case, the file descriptor associated with the stream need not be closed if the call to freopen() succeeds. It is implementation-defined which changes of mode are permitted (if any), and under what circumstances.

After a successful call to the freopen() function, the orientation of the stream shall be cleared, ^[XSI]  the encoding rule shall be cleared, and the associated mbstate_t object shall be set to describe an initial conversion state.

^[CX] The largest value that can be represented correctly in an object of type off_t shall be established as the offset maximum in the open file description.

RETURN VALUE

Upon successful completion, freopen() shall return the value of stream. Otherwise, a null pointer shall be returned, ^[CX]  and errno shall be set to indicate the error.

ERRORS

The freopen() function shall fail if:

[EACCES]

^[CX] Search permission is denied on a component of the path prefix, or the file exists and the permissions specified by mode are denied, or the file does not exist and write permission is denied for the parent directory of the file to be created.

[EBADF]

^[CX] The file descriptor underlying the stream is not a valid file descriptor when filename is a null pointer.

[EINTR]

^[CX] A signal was caught during freopen().

[EISDIR]

^[CX] The named file is a directory and mode requires write access.

[ELOOP]

^[CX] A loop exists in symbolic links encountered during resolution of the path argument.

[EMFILE]

^[CX] {OPEN_MAX} file descriptors are currently open in the calling process.

[ENAMETOOLONG]

^[CX]
The length of the filename argument exceeds {PATH_MAX} or a pathname component is longer than {NAME_MAX}.

[ENFILE]

^[CX] The maximum allowable number of files is currently open in the system.

[ENOENT]

^[CX] A component of filename does not name an existing file or filename is an empty string.

[ENOSPC]

^[CX] The directory or file system that would contain the new file cannot be expanded, the file does not exist, and it was to be created.

[ENOTDIR]

^[CX] A component of the path prefix is not a directory.

[ENXIO]

^[CX] The named file is a character special or block special file, and the device associated with this special file does not exist.

[EOVERFLOW]

^[CX] The named file is a regular file and the size of the file cannot be represented correctly in an object of type off_t.

[EROFS]

^[CX] The named file resides on a read-only file system and mode requires write access.

The freopen() function may fail if:

[EBADF]

^[CX] The mode with which the file descriptor underlying the stream was opened does not support the requested mode when filename is a null pointer.

[EINVAL]

^[CX] The value of the mode argument is not valid.

[ELOOP]

^[CX] More than {SYMLOOP_MAX} symbolic links were encountered during resolution of the path argument.

[ENAMETOOLONG]

^[CX]
Pathname resolution of a symbolic link produced an intermediate result whose length exceeds {PATH_MAX}.

[ENOMEM]

^[CX] Insufficient storage space is available.

[ENXIO]

^[CX] A request was made of a nonexistent device, or the request was outside the capabilities of the device.

[ETXTBSY]

^[CX] The file is a pure procedure (shared text) file that is being executed and mode requires write access.

EXAMPLES

Directing Standard Output to a File

The following example logs all standard output to the /tmp/logfile file.

#include <stdio.h>
...
FILE *fp;
...
fp = freopen ("/tmp/logfile", "a+", stdout);
...

APPLICATION USAGE

The freopen() function is typically used to attach the preopened streams associated with stdin, stdout, and stderr to other files.

RATIONALE

None.

FUTURE DIRECTIONS

None.

SEE ALSO

fclose(), fopen(), fdopen() , mbsinit(), the Base Definitions volume of IEEE Std 1003.1-2001, <stdio.h>

CHANGE HISTORY

First released in Issue 1. Derived from Issue 1 of the SVID.

Issue 5

The DESCRIPTION is updated to indicate that the orientation of the stream is cleared and the conversion state of the stream is set to an initial conversion state by a successful call to the freopen() function.

Large File Summit extensions are added.

Issue 6

Extensions beyond the ISO C standard are marked.

The following new requirements on POSIX implementations derive from alignment with the Single UNIX Specification:

• In the DESCRIPTION, text is added to indicate setting of the offset maximum in the open file description. This change is to support large files.

• In the ERRORS section, the [EOVERFLOW] condition is added. This change is to support large files.

• The [ELOOP] mandatory error condition is added.

• A second [ENAMETOOLONG] is added as an optional error condition.

• The [EINVAL], [ENOMEM], [ENXIO], and [ETXTBSY] optional error conditions are added.

The following changes are made for alignment with the ISO/IEC 9899:1999 standard:

• The freopen() prototype is updated.

• The DESCRIPTION is updated.

The wording of the mandatory [ELOOP] error condition is updated, and a second optional [ELOOP] error condition is added.

The DESCRIPTION is updated regarding failure to close, changing the "file" to "file descriptor".

IEEE Std 1003.1-2001/Cor 2-2004, item XSH/TC2/D6/40 is applied, adding the sentence "In this case, the file descriptor associated with the stream need not be closed if the call to freopen() succeeds." to the DESCRIPTION.

IEEE Std 1003.1-2001/Cor 2-2004, item XSH/TC2/D6/41 is applied, adding an mandatory [EBADF] error, and an optional [EBADF] error to the ERRORS section.