Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

                       FS_FLAGS   mode
                       FS_ERR    *p_err);

File

Called from

Code enabled by

fs_file.c

Application;

fs_fopen()

N/A

...

name_full

Name of the file. See section 4-3 “μCthe sub-topic "µC/FS File and Directory Names and Paths” for information about file namesPaths" in the topic Useful Information.

mode

File access mode (see Notes #1 and #2).

...

Returned Value

None.

Notes/Warnings

  • The access mode should be the logical OR of one or more flags :

FS_FILE_ACCESS_MODE_RD

File opened for reads.

...

File data will be cached.

  • If FS_FILE_ACCESS_MODE_TRUNC is set, then FS_FILE_ACCESS_MODE_WR must also be set.
  • If FS_FILE_ACCESS_MODE_EXCL is set, then FS_FILE_ACCESS_MODE_CREATE must also be set.
  • FS_FILE_ACCESS_MODE_RD and/or FS_FILE_ACCESS_MODE_WR must be set.
  • The mode string argument of fs_fopen() function can specify a subset of the possible valid modes for this function. The equivalent modes of fs_fopen() mode strings are shown in Table 5-4.

fopen() Mode String

mode Equivalent

“r” or “rb”

FS_FILE_ACCESS_MODE_RD

“w” or “wb”

FS_FILE_ACCESS_MODE_WR |
FS_FILE_ACCESS_MODE_CREATE |
FS_FILE_ACCESS_MODE_TRUNC

“a” or “ab”

FS_FILE_ACCESS_MODE_WR |
FS_FILE_ACCESS_MODE_CREATE |
FS_FILE_ACCESS_MODE_APPEND

“r+” or “rb+” or “r+b”

FS_FILE_ACCESS_MODE_RD |
FS_FILE_ACCESS_MODE_WR

“w+” or “wb+” or “w+b”

FS_FILE_ACCESS_MODE_RD |
FS_FILE_ACCESS_MODE_WR |
FS_FILE_ACCESS_MODE_CREATE |
FS_FILE_ACCESS_MODE_TRUNC

“a+” or “ab+” or “a+b”

FS_FILE_ACCESS_MODE_RD |

FS_FILE_ACCESS_MODE_WR |
FS_FILE_ACCESS_MODE_CREATE |

FS_FILE_ACCESS_MODE_APPEND

...