VFErr

Error

VF_ERR_SUCCESS 0 No error.

VF_ERR_EPERM 1 Not a possible operation.
Returned when an attempt is made to read a locked file.
Under the current VF, this error value is not returned because a lock-related function does not exist.

VF_ERR_ENOENT 2 The target file or directory does not exist.
This is returned when an invalid file path is specified for a function, using a file path such as VFOpenFile.

VF_ERR_EIO 5 This error occurs with NANDRead(), and so on, when one of the device's library functions fails.
You must use the VFGetLastDeviceError function to get the NAND error value and then perform the process that complies with the guidelines for that device.

VF_ERR_ENOEXEC 8 A runtime format error.
This error occurs when an attempt is made to delete a directory that is not empty, and for general operations that are inappropriate for the given read/write restrictions, such as trying to write to a read-only file. Since this is a logic error, it should be dealt with at the development stage. You should prepare ways of handling the error such as stopping the process since a read-only file cannot be changed, or recreating the archive if not being able to make the changes would be fatal.
VF_ERR_EBADF 9 Invalid file descriptor.
This error is returned when a fatal problem arises at the level of the FAT table.
Because the directory structure of the vff archive has been corrupted, you must handle it the same way as when the Save Data is corrupted, recreating the vff file. This error does not occur within the normal scope of using VF.

VF_ERR_ENOMEM 12 Occurs when the drive is mounted if there is not enough VF cache memory for the size of the given vff file.
When this error is detected, use VFMountXXXCache to increase the size of the cache.

VF_ERR_EACCES 13 This operation is not permitted.
This is returned when VFUnmountDrive is run for the drive while a file is open.

VF_ERR_EEXIST 17 The file or directory already exists.
This error is returned when trying to create a file or directory that already exists.

VF_ERR_EISDIR 21 This error is returned when a directory is specified for VFOpenFile.

VF_ERR_EINVAL 22 The argument is invalid.
The file name, path name, parameter, or drive may be invalid.
In addition, this error is returned when trying to seek before the start of a file.

VF_ERR_ENFILE 23 There are too many open files in VF.
Up to five files for each drive can be open simultaneously in VF.
This error is returned when trying to open a sixth file in VF.

VF_ERR_EMFILE 24 The user has too many open files.
For each drive, up to five files can be open simultaneously.
This error is returned when trying to open a sixth file.

VF_ERR_EFBIG 27 The file size limitation has been exceeded.
This error is returned when trying to access a file that has a size in excess of the 4 GB maximum.

VF_ERR_ENOSPC 28 There is no space on the drive.
This error is returned when a write that exceeds the total sectors is attempted with a function such as VFWriteFile.

VF_ERR_ENOLCK 46 Lock is not allowed.
Currently, this error is not returned.

VF_ERR_ENOSYS 88 This feature is not implemented.
Currently, this error is not returned.

VF_ERR_ENOTEMPTY 90 There is no space in the directory.
This error is returned when an entry region cannot be allocated when creating a file or directory.

VF_ERR_SYSTEM -1 This is a VF internal error.
The error occurs in one of three cases:
* The SD library calls an SD mount function without being linked
* VFGetLastDeviceError(W) is called before mounting
* The argument for VFGetOffsetByFd is NULL
It would be better to handle this in the application with the equivalent of an assert.

VF_ERR_NOT_EXIST_FILE 0xB001 The vff file does not exist.
This error is returned when a .vff file that does not exist is specified with VFMountDrive.

VF_ERR_CANNOT_ALLOC_DRV 0xB002 Too many volumes are attached.
This error is returned when trying to attach (mount) a drive when 26 drives are already attached (mounted).

VF_ERR_NOT_ALLOCATED_DRV 0xB003 The drive could not be allocated.
This error is returned when specifying the name of an unmounted drive in a function such as VFCreateFile.

VF_ERR_ALREADY_ATTACHED_DRV_NAME 0xB004 This drive name has already been attached.
This error is returned when running VFAttachDrive for a drive name that has already been attached.

VF_ERR_ALREADY_MOUNTED_DRV_NAME 0xB005 This drive name has already been mounted.
This error is returned when running VFMountDrive for a drive name that has already been mounted.

VF_ERR_VFF_FILE_FORMAT 0xB006 The .vff file format is invalid.
Drives being handled for the first time must be formatted with VFFormatDrive. In this case, delete the .vff file, and then create it again with VFCreateSystemFile.

Revision History

2006/11/14
2007/05/08 Corrected the error descriptions.
2007/09/10 Added descriptions of errors.

CONFIDENTIAL

*VF_ERR_SUCCESS*	0	No error.
*VF_ERR_EPERM*	1	Not a possible operation. Returned when an attempt is made to read a locked file. Under the current VF, this error value is not returned because a lock-related function does not exist.
*VF_ERR_ENOENT*	2	The target file or directory does not exist. This is returned when an invalid file path is specified for a function, using a file path such as `VFOpenFile`.
*VF_ERR_EIO*	5	This error occurs with `NANDRead()`, and so on, when one of the device's library functions fails. You must use the `VFGetLastDeviceError` function to get the NAND error value and then perform the process that complies with the guidelines for that device.
*VF_ERR_ENOEXEC*	8	A runtime format error. This error occurs when an attempt is made to delete a directory that is not empty, and for general operations that are inappropriate for the given read/write restrictions, such as trying to write to a read-only file. Since this is a logic error, it should be dealt with at the development stage. You should prepare ways of handling the error such as stopping the process since a read-only file cannot be changed, or recreating the archive if not being able to make the changes would be fatal.
*VF_ERR_EBADF*	9	Invalid file descriptor. This error is returned when a fatal problem arises at the level of the FAT table. Because the directory structure of the `vff` archive has been corrupted, you must handle it the same way as when the Save Data is corrupted, recreating the `vff` file. This error does not occur within the normal scope of using VF.
*VF_ERR_ENOMEM*	12	Occurs when the drive is mounted if there is not enough VF cache memory for the size of the given `vff` file. When this error is detected, use `VFMountXXXCache` to increase the size of the cache.
*VF_ERR_EACCES*	13	This operation is not permitted. This is returned when `VFUnmountDrive` is run for the drive while a file is open.
*VF_ERR_EEXIST*	17	The file or directory already exists. This error is returned when trying to create a file or directory that already exists.
*VF_ERR_EISDIR*	21	This error is returned when a directory is specified for `VFOpenFile`.
*VF_ERR_EINVAL*	22	The argument is invalid. The file name, path name, parameter, or drive may be invalid. In addition, this error is returned when trying to seek before the start of a file.
*VF_ERR_ENFILE*	23	There are too many open files in VF. Up to five files for each drive can be open simultaneously in VF. This error is returned when trying to open a sixth file in VF.
*VF_ERR_EMFILE*	24	The user has too many open files. For each drive, up to five files can be open simultaneously. This error is returned when trying to open a sixth file.
*VF_ERR_EFBIG*	27	The file size limitation has been exceeded. This error is returned when trying to access a file that has a size in excess of the 4 GB maximum.
*VF_ERR_ENOSPC*	28	There is no space on the drive. This error is returned when a write that exceeds the total sectors is attempted with a function such as `VFWriteFile`.
*VF_ERR_ENOLCK*	46	Lock is not allowed. Currently, this error is not returned.
*VF_ERR_ENOSYS*	88	This feature is not implemented. Currently, this error is not returned.
*VF_ERR_ENOTEMPTY*	90	There is no space in the directory. This error is returned when an entry region cannot be allocated when creating a file or directory.
*VF_ERR_SYSTEM*	-1	This is a VF internal error. The error occurs in one of three cases: * The SD library calls an SD mount function without being linked * `VFGetLastDeviceError(W)` is called before mounting * The argument for `VFGetOffsetByFd` is NULL It would be better to handle this in the application with the equivalent of an assert.
*VF_ERR_NOT_EXIST_FILE*	0xB001	The vff file does not exist. This error is returned when a .vff file that does not exist is specified with `VFMountDrive`.
*VF_ERR_CANNOT_ALLOC_DRV*	0xB002	Too many volumes are attached. This error is returned when trying to attach (mount) a drive when 26 drives are already attached (mounted).
*VF_ERR_NOT_ALLOCATED_DRV*	0xB003	The drive could not be allocated. This error is returned when specifying the name of an unmounted drive in a function such as `VFCreateFile`.
*VF_ERR_ALREADY_ATTACHED_DRV_NAME*	0xB004	This drive name has already been attached. This error is returned when running `VFAttachDrive` for a drive name that has already been attached.
*VF_ERR_ALREADY_MOUNTED_DRV_NAME*	0xB005	This drive name has already been mounted. This error is returned when running `VFMountDrive` for a drive name that has already been mounted.
*VF_ERR_VFF_FILE_FORMAT*	0xB006	The .vff file format is invalid. Drives being handled for the first time must be formatted with `VFFormatDrive`. In this case, delete the .vff file, and then create it again with `VFCreateSystemFile`.