FOPEN(3) BSD Library Functions Manual FOPEN(3)

NAME
     ffooppeenn, ffddooppeenn, ffrreeooppeenn - stream open functions

LLIIBBRRAARRYY
     Standard C Library (libc, -lc)

SYNOPSIS
     ##iinncclluuddee <>

     FILE *
     ffooppeenn(const char * restrict path, const char * restrict mode);

     FILE *
     ffddooppeenn(int fildes, const char *mode);

     FILE *
     ffrreeooppeenn(const char *path, const char *mode, FILE *stream);

DESCRIPTION
     The ffooppeenn() 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.  Subsequent writes
             to the file will always end up at the then current end of file,
             irrespective of any intervening fseek(3) or similar.

     ``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.  Subse-
             quent writes to the file will always end up at the then current
             end of file, irrespective of any intervening fseek(3) or similar.

     The mode string can also include the letter ``b'' either as a third char-
     acter or as a character between the characters in any of the two-charac-
     ter strings described above.  This is strictly for compatibility with
     ISO/IEC 9899:1990 (``ISO C90'') and has no effect; the ``b'' is ignored.

     Any created files will have mode "SIRUSR | SIWUSR | SIRGRP | SIWGRP |
     SIROTH | SIWOTH" (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 ffddooppeenn() function associates a stream with the existing file descrip-
     tor, fildes.  The mode of the stream must be compatible with the mode of
     the file descriptor.  When the stream is closed via fclose(3), fildes is
     closed also.

     The ffrreeooppeenn() 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 ffooppeenn() function.

     If the path argument is NULL, ffrreeooppeenn() attempts to re-open the file
     associated with stream with a new mode.  The new mode must be compatible
     with the mode that the stream was originally opened with:

           ++oo   Streams originally opened with mode ``r'' can only be reopened
               with that same mode.

           ++oo   Streams originally opened with mode ``a'' can be reopened with
               the same mode, or mode ``w''.

           ++oo   Streams originally opened with mode ``w'' can be reopened with
               the same mode, or mode ``a''.

           ++oo   Streams originally opened with mode ``r+'', ``w+'', or ``a+''
               can be reopened with any mode.

     The primary use of the ffrreeooppeenn() function is to change the file associ-
     ated with a standard text stream (stderr, stdin, or stdout).

RETURN VALUES
     Upon successful completion ffooppeenn(), ffddooppeenn() and ffrreeooppeenn() return a FILE
     pointer.  Otherwise, NULL is returned and the global variable errno is
     set to indicate the error.

EERRRROORRSS
     [EINVAL]           The mode argument to ffooppeenn(), ffddooppeenn(), or ffrreeooppeenn()
                        was invalid.

     The ffooppeenn(), ffddooppeenn() and ffrreeooppeenn() functions may also fail and set errno
     for any of the errors specified for the routine malloc(3).

     The ffooppeenn() function may also fail and set errno for any of the errors
     specified for the routine open(2).

     The ffddooppeenn() function may also fail and set errno for any of the errors
     specified for the routine fcntl(2).

     The ffrreeooppeenn() 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), fileno(3), fseek(3), funopen(3)

STANDARDS     The ffooppeenn() and ffrreeooppeenn() functions conform to ISO/IEC 9899:1990
     (``ISO C90'').  The ffddooppeenn() function conforms to IEEE Std 1003.1-1988
     (``POSIX.1'').

BSD                            January 26, 2003                            BSD