FatFs file functions

FatFs file functions. More...

Topics
	File Access Mode
	File access mode and open method flags (3rd argument of f_open())

Data Structures
struct	FIL
	FatFs file structure used in file operations. More...

Macros
#define	f_size(fp)
	File size.
#define	f_tell(fp)
	File position.
#define	f_eof(fp)
	File EOF indicator.
#define	EOF   (-1)
	EOF character definition.

Enumerations
enum	FRESULT {   FR_OK = 0 , FR_DISK_ERR , FR_INT_ERR , FR_NOT_READY ,   FR_NO_FILE , FR_NO_PATH , FR_INVALID_NAME , FR_DENIED ,   FR_EXIST , FR_INVALID_OBJECT , FR_WRITE_PROTECTED , FR_INVALID_DRIVE ,   FR_NOT_ENABLED , FR_NO_FILESYSTEM , FR_MKFS_ABORTED , FR_TIMEOUT ,   FR_LOCKED , FR_NOT_ENOUGH_CORE , FR_TOO_MANY_OPEN_FILES , FR_INVALID_PARAMETER }
	File function return code (FRESULT) More...

Functions
FRESULT	f_open (FIL *fp, const TCHAR *path, BYTE mode)
	Open or create a file.
FRESULT	f_close (FIL *fp)
	Close an open file object.
FRESULT	f_read (FIL *fp, void *buff, UINT btr, UINT *br)
	Read data from the file.
FRESULT	f_write (FIL *fp, const void *buff, UINT btw, UINT *bw)
	Write data to the file.
FRESULT	f_lseek (FIL *fp, FSIZE_t ofs)
	Move file pointer of the file object.
FRESULT	f_rename (const TCHAR *path_old, const TCHAR *path_new)
	Rename/Move a file or directory.
FRESULT	f_unlink (const TCHAR *path)
	Delete an existing file or directory.

Detailed Description

FatFs file functions.

Used FatFS version R0.12c - for doc see (http://elm-chan.org/fsw/ff/00index_e.html).

Note that only functions mentioned here are supported.

Macro Definition Documentation

f_eof

#define f_eof

(

fp

)

Value:

((int)((fp)->fptr == (fp)->obj.objsize))

File EOF indicator.

f_size

#define f_size

(

fp

)

Value:

((fp)->obj.objsize)

File size.

f_tell

#define f_tell

(

fp

)

Value:

((fp)->fptr)

File position.

Enumeration Type Documentation

FRESULT

enum FRESULT

File function return code (FRESULT)

Enumerator
FR_OK	(0) Succeeded
FR_DISK_ERR	(1) A hard error occurred in the low level disk I/O layer
FR_INT_ERR	(2) Assertion failed
FR_NOT_READY	(3) The physical drive cannot work
FR_NO_FILE	(4) Could not find the file
FR_NO_PATH	(5) Could not find the path
FR_INVALID_NAME	(6) The path name format is invalid
FR_DENIED	(7) Access denied due to prohibited access or directory full
FR_EXIST	(8) Access denied due to prohibited access
FR_INVALID_OBJECT	(9) The file/directory object is invalid
FR_WRITE_PROTECTED	(10) The physical drive is write protected
FR_INVALID_DRIVE	(11) The logical drive number is invalid
FR_NOT_ENABLED	(12) The volume has no work area
FR_NO_FILESYSTEM	(13) There is no valid FAT volume
FR_MKFS_ABORTED	(14) The f_mkfs() aborted due to any problem
FR_TIMEOUT	(15) Could not get a grant to access the volume within defined period
FR_LOCKED	(16) The operation is rejected according to the file sharing policy
FR_NOT_ENOUGH_CORE	(17) LFN working buffer could not be allocated
FR_TOO_MANY_OPEN_FILES	(18) Number of open files > _FS_LOCK
FR_INVALID_PARAMETER	(19) Given parameter is invalid