X-Git-Url: http://cloudbase.mooo.com/gitweb/z180-stamp.git/blobdiff_plain/70702af1370e44e32fb2c3c507e4759a187b4fe5..289f6a146c0b2087607d8d8659531ea90142779a:/fatfs/documents/doc/rc.html diff --git a/fatfs/documents/doc/rc.html b/fatfs/documents/doc/rc.html new file mode 100644 index 0000000..05bcf9e --- /dev/null +++ b/fatfs/documents/doc/rc.html @@ -0,0 +1,130 @@ + + + + + + + + +FatFs - API Return Code + + + +

Return Code of API Functions

+

Most of API functions return common result code as enum type FRESULT. When an API function succeeded, it returns zero (FR_OK), otherwise it returns non-zero value indicates type of error.

+ +
+ +
FR_OK (0)
+
The function succeeded.
+ +
FR_DISK_ERR
+
The lower layer, disk_read, disk_write or disk_ioctl function, reported that an unrecoverable hard error occured.
Note that if once this error occured at any operation to an open file, the file object is aborted and any operations to the file except for close will be rejected.
+ +
FR_INT_ERR
+
Assertion failed. An insanity is detected in the internal process. One of the following possibilities is suspected. + +Note that if once this error occured at any operation to an open file, the file object is aborted and all operations to the file except for close will be rejected. +
+ +
FR_NOT_READY
+
The lower layer, disk_initialize function, reported that the storage device could not be got ready to work. One of the following possibilities is suspected. + +
+ +
FR_NO_FILE
+
Could not find the file.
+ +
FR_NO_PATH
+
Could not find the path.
+ +
FR_INVALID_NAME
+
The given string is invalid as the path name. One of the following possibilities is suspected. + +
+ +
FR_DENIED
+
The required access was denied due to one of the following reasons: + +
+ +
FR_EXIST
+
Name collision. An object with the same name is already existing.
+ +
FR_INVALID_OBJECT
+
The file/directory object is invalid or a null pointer is given. There are some reasons as follows: + +
+ +
FR_WRITE_PROTECTED
+
A write mode operation against the write-protected media.
+ +
FR_INVALID_DRIVE
+
Invalid drive number is specified in the path name. A null pointer is given as the path name. (Related option: FF_VOLUMES)
+ +
FR_NOT_ENABLED
+
Work area for the logical drive has not been registered by f_mount function.
+ +
FR_NO_FILESYSTEM
+
There is no valid FAT volume on the drive or wrong lower layer implementation.
+ +
FR_MKFS_ABORTED
+
The f_mkfs function aborted before start in format due to a reason as follows: + +
+ +
FR_TIMEOUT
+
The function was canceled due to a timeout of thread-safe control. (Related option: FF_TIMEOUT)
+ +
FR_LOCKED
+
The operation to the object was rejected by file sharing control. (Related option: FF_FS_LOCK)
+ +
FR_NOT_ENOUGH_CORE
+
Not enough memory for the operation. There is one of the following reasons: + +
+ +
FR_TOO_MANY_OPEN_FILES
+
Number of open objects has been reached maximum value and no more object can be opened. (Related option: FF_FS_LOCK)
+ +
FR_INVALID_PARAMETER
+
The given parameter is invalid or there is an inconsistent for the volume.
+
+ +

Return

+ +