FSFile_Open()

File

Called from

Code enabled by

fs_file.c

Application;

fs_fopen()

N/A

Open a file.

See fs_fopen() for more information.

Arguments

name_full

Name of the file. See the sub-topic "µC/FS File and Directory Names and Paths" in the topic Useful Information.

mode

File access mode (see Notes).

p_err

Pointer to variable that will the receive return error code from this function:

FS_ERR_NONE

File opened.

FS_ERR_NAME_NULL

Argument name_full passed a NULL pointer.

Or entry error (see µC/FS Error Codes).

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.
`FS_FILE_ACCESS_MODE_WR`	File opened for writes.
`FS_FILE_ACCESS_MODE_CREATE`	File will be created, if necessary.
`FS_FILE_ACCESS_MODE_TRUNC`	File length will be truncated to 0.
`FS_FILE_ACCESS_MODE_APPEND`	All writes will be performed at EOF.
`FS_FILE_ACCESS_MODE_EXCL`	File will be opened if and only if it does not already exist.
`FS_FILE_ACCESS_MODE_CACHED`	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 the table below.

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`