fopen.3ucb revision c10c16dec587a0662068f6e2991c29ed3a9db943
te
Copyright (c) 2007 Sun Microsystems, Inc. All Rights Reserved.
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]
fopen 3UCB "30 Oct 2007" "SunOS 5.11" "SunOS/BSD Compatibility Library Functions"
NAME
fopen, freopen - open a stream
SYNOPSIS

/usr/ucb/cc [ flag ... ] file ...
#include <stdio.h>

FILE *fopen(file, mode)
const char *file, *mode;

FILE *freopen(file, mode, iop)
const char *file, *mode;
register FILE *iop;
DESCRIPTION

The fopen() function opens the file specified by file and associates a stream with it. If the open succeeds, fopen() returns a pointer to be used to identify the stream in subsequent operations. The file argument points to a character string that contains the name of the file to be opened. The mode argument is a character string having one of the following values:

r

open for reading

w

truncate or create for writing

a

append: open for writing at end of file, or create for writing

r+

open for update (reading and writing)

w+

truncate or create for update

a+

append; open or create for update at EOF

The freopen() function opens the file specified by file and associates the stream pointed to by iop with it. The mode argument is used just as in fopen(). The original stream is closed, regardless of whether the open ultimately succeeds. If the open succeeds, freopen() returns the original value of iop.

The freopen() function is typically used to attach the pre-opened streams associated withstdin, stdout, and stderr to other files.

When a file is opened for update, both input and output can be performed on the resulting stream. Output cannot be directly followed by input without an intervening fseek(3C) or rewind(3C). Input cannot be directly followed by output without an intervening fseek(3C) or rewind(3C). An input operation that encounters EOF will fail.

RETURN VALUES

The fopen() and freopen() functions return a NULL pointer on failure.

USAGE

The fopen() and freopen() functions have transitional interfaces for 64-bit file offsets. See lf64(5).

SEE ALSO

open(2), fclose(3C), fopen(3C), freopen(3C), fseek(3C), malloc(3C), rewind(3C), lf64(5)

NOTES

Use of these functions should be restricted to applications written on BSD platforms. Use of these functions with any of the system libraries or in multithreaded applications is unsupported.

To support the same number of open files as the system, fopen() must allocate additional memory for data structures using malloc(3C) after 64 files have been opened. This confuses some programs that use their own memory allocators.

The fopen() and freopen() functions differ from the standard I/O functions fopen(3C) and freopen(3C). The standard I/O functions distinguish binary from text files with an additional use of 'b' as part of the mode, enabling portability of fopen(3C) and freopen(3C) beyond SunOS 4.x systems.