FSU_FOPEN(3)

NAME
fsu_fopen - stream open function

LIBRARY
fsu_utils Library (libfsu_utils, -lfsu_utils)

SYNOPSIS
#include <fsu_utils.h>
FSU_FILE *
fsu_fopen(struct ukfs *fs, const char * path, const char * mode);

DESCRIPTION
The fsu_fopen() 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 for reading.

“r+”
    Open for reading and writing.

“w” Open for writing. Truncate file to zero length or create file.

“w+”
    Open for reading and writing. Truncate file to zero length or create file.

“a” Append; open for writing. The file is created if it does not exist.

“a+”
    Append; open for reading and writing. The file is created if it does not exist.

The mode string can also include the letter ``b'' either as a last character or as a character between the characters in any of the two-character strings described above. This is strictly for compatibility with ansiC and has no effect; the ``b'' is ignored.

The letter ``f'' in the mode string restricts fsu_fopen to regular files; if the file opened is not a regular file, fsu_fopen() will fail. This is a non ansiC extension.

Any created files will have mode \*qS_IRUSR | S_IWUSR | S_IRGRP | S_IWGRP | S_IROTH | S_IWOTH\*q (0666), as modified by the process' umask value (see umask(2)).

Opening a file with append mode causes all subsequent writes to it to be forced to the then current end of file, regardless of intervening repositioning of the stream.

The fsu_fopen() function initially position the stream at the start of the file unless the file is opened with append mode, in which case the stream is initially positioned at the end of the file.

RETURN VALUES
Upon successful completion fsu_fopen() returns a FSU_FILE pointer. Otherwise, NULL is returned and the global variable errno is set to indicate the error.

ERRORS

[EINVAL]
    The mode provided to fsu_fopen() was invalid.

[EFTYPE]
    The file is not a regular file and the character ``f'' is specified in the mode.

The fsu_fopen() function may also fail and set errno for any of the errors specified for the routine malloc(3).

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

SEE ALSO
fsu_fclose(3), fsu_fseek(3)