ReactOS 0.4.15-dev-8021-g7ce96fd
ff_error.h File Reference
#include "ff_config.h"
#include "ff_types.h"
Include dependency graph for ff_error.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros

#define FF_GETERROR(x)   (x & 0x0000FFFF)
 
#define FF_MODULE_SHIFT   24
 
#define FF_FUNCTION_SHIFT   16
 
#define FF_MODULE_IOMAN   (1 << FF_MODULE_SHIFT)
 
#define FF_MODULE_DIR   (2 << FF_MODULE_SHIFT)
 
#define FF_MODULE_FILE   (3 << FF_MODULE_SHIFT)
 
#define FF_MODULE_FAT   (4 << FF_MODULE_SHIFT)
 
#define FF_MODULE_CRC   (5 << FF_MODULE_SHIFT)
 
#define FF_MODULE_FORMAT   (6 << FF_MODULE_SHIFT)
 
#define FF_MODULE_HASH   (7 << FF_MODULE_SHIFT)
 
#define FF_MODULE_MEMORY   (8 << FF_MODULE_SHIFT)
 
#define FF_MODULE_STRING   (9 << FF_MODULE_SHIFT)
 
#define FF_MODULE_UNICODE   (10 << FF_MODULE_SHIFT)
 
#define FF_MODULE_SAFETY   (11 << FF_MODULE_SHIFT)
 
#define FF_MODULE_TIME   (12 << FF_MODULE_SHIFT)
 
#define FF_MODULE_DRIVER   (13 << FF_MODULE_SHIFT)
 
#define FF_CREATEIOMAN   (1 << FF_FUNCTION_SHIFT) | FF_MODULE_IOMAN
 
#define FF_DESTROYIOMAN   (2 << FF_FUNCTION_SHIFT) | FF_MODULE_IOMAN
 
#define FF_REGISTERBLKDEVICE   (3 << FF_FUNCTION_SHIFT) | FF_MODULE_IOMAN
 
#define FF_UNREGISTERBLKDEVICE   (4 << FF_FUNCTION_SHIFT) | FF_MODULE_IOMAN
 
#define FF_MOUNTPARTITION   (5 << FF_FUNCTION_SHIFT) | FF_MODULE_IOMAN
 
#define FF_UNMOUNTPARTITION   (6 << FF_FUNCTION_SHIFT) | FF_MODULE_IOMAN
 
#define FF_FLUSHCACHE   (7 << FF_FUNCTION_SHIFT) | FF_MODULE_IOMAN
 
#define FF_GETPARTITIONBLOCKSIZE   (8 << FF_FUNCTION_SHIFT) | FF_MODULE_IOMAN
 
#define FF_BLOCKREAD   (9 << FF_FUNCTION_SHIFT) | FF_MODULE_IOMAN
 
#define FF_BLOCKWRITE   (10 << FF_FUNCTION_SHIFT) | FF_MODULE_IOMAN
 
#define FF_ERR_NONE   0
 No Error.
 
#define FF_ERR_NULL_POINTER   2
 pIoman was NULL.
 
#define FF_ERR_NOT_ENOUGH_MEMORY   3
 malloc() failed! - Could not allocate handle memory.
 
#define FF_ERR_DEVICE_DRIVER_FAILED   4
 The Block Device driver reported a FATAL error, cannot continue.
 
#define FF_ERR_IOMAN_BAD_BLKSIZE   11
 The provided blocksize was not a multiple of 512.
 
#define FF_ERR_IOMAN_BAD_MEMSIZE   12
 The memory size was not a multiple of the blocksize.
 
#define FF_ERR_IOMAN_DEV_ALREADY_REGD   13
 Device was already registered. Use FF_UnRegister() to re-use this IOMAN with another device.
 
#define FF_ERR_IOMAN_NO_MOUNTABLE_PARTITION   14
 A mountable partition could not be found on the device.
 
#define FF_ERR_IOMAN_INVALID_FORMAT   15
 The.
 
#define FF_ERR_IOMAN_INVALID_PARTITION_NUM   16
 The partition number provided was out of range.
 
#define FF_ERR_IOMAN_NOT_FAT_FORMATTED   17
 The partition did not look like a FAT partition.
 
#define FF_ERR_IOMAN_DEV_INVALID_BLKSIZE   18
 IOMAN object BlkSize is not compatible with the blocksize of this device driver.
 
#define FF_ERR_IOMAN_PARTITION_MOUNTED   19
 Device is in use by an actively mounted partition. Unmount the partition first.
 
#define FF_ERR_IOMAN_ACTIVE_HANDLES   20
 The partition cannot be unmounted until all active file handles are closed. (There may also be active handles on the cache).
 
#define FF_ERR_IOMAN_GPT_HEADER_CORRUPT   21
 The GPT partition table appears to be corrupt, refusing to mount.
 
#define FF_ERR_IOMAN_NOT_ENOUGH_FREE_SPACE   22
 
#define FF_ERR_IOMAN_OUT_OF_BOUNDS_READ   23
 
#define FF_ERR_IOMAN_OUT_OF_BOUNDS_WRITE   24
 
#define FF_ERR_FILE_ALREADY_OPEN   30
 File is in use.
 
#define FF_ERR_FILE_NOT_FOUND   31
 File was not found.
 
#define FF_ERR_FILE_OBJECT_IS_A_DIR   32
 Tried to FF_Open() a Directory.
 
#define FF_ERR_FILE_IS_READ_ONLY   33
 Tried to FF_Open() a file marked read only.
 
#define FF_ERR_FILE_INVALID_PATH   34
 The path of the file was not found.
 
#define FF_ERR_FILE_NOT_OPENED_IN_WRITE_MODE   35
 
#define FF_ERR_FILE_NOT_OPENED_IN_READ_MODE   36
 
#define FF_ERR_FILE_EXTEND_FAILED   37
 Could not extend the file.
 
#define FF_ERR_FILE_DESTINATION_EXISTS   38
 
#define FF_ERR_FILE_SOURCE_NOT_FOUND   39
 
#define FF_ERR_FILE_DIR_NOT_FOUND   40
 
#define FF_ERR_FILE_COULD_NOT_CREATE_DIRENT   41
 
#define FF_ERR_DIR_OBJECT_EXISTS   50
 A file or folder of the same name already exists in the current directory.
 
#define FF_ERR_DIR_DIRECTORY_FULL   51
 No more items could be added to the directory.
 
#define FF_ERR_DIR_END_OF_DIR   52
 
#define FF_ERR_DIR_NOT_EMPTY   53
 Cannot delete a directory that contains files or folders.
 
#define FF_ERR_DIR_INVALID_PATH   54
 Could not find the directory specified by the path.
 
#define FF_ERR_DIR_CANT_EXTEND_ROOT_DIR   55
 Can't extend the root dir.
 
#define FF_ERR_DIR_EXTEND_FAILED   56
 Not enough space to extend the directory.
 
#define FF_ERR_DIR_NAME_TOO_LONG   57
 Name exceeds the number of allowed charachters for a filename.
 
#define FF_ERR_FAT_NO_FREE_CLUSTERS   70
 No more free space is available on the disk.
 
#define FF_ERR_UNICODE_INVALID_CODE   100
 An invalid Unicode charachter was provided!
 
#define FF_ERR_UNICODE_DEST_TOO_SMALL   101
 Not enough space in the UTF-16 buffer to encode the entire sequence as UTF-16.
 
#define FF_ERR_UNICODE_INVALID_SEQUENCE   102
 An invalid UTF-16 sequence was encountered.
 
#define FF_ERR_UNICODE_CONVERSION_EXCEEDED   103
 Filename exceeds MAX long-filename length when converted to UTF-16.
 

Functions

const FF_T_INT8FF_GetErrMessage (FF_ERROR iErrorCode)
 

Detailed Description

Author
James Walmsley

Definition in file ff_error.h.

Macro Definition Documentation

◆ FF_BLOCKREAD

#define FF_BLOCKREAD   (9 << FF_FUNCTION_SHIFT) | FF_MODULE_IOMAN

Definition at line 81 of file ff_error.h.

◆ FF_BLOCKWRITE

#define FF_BLOCKWRITE   (10 << FF_FUNCTION_SHIFT) | FF_MODULE_IOMAN

Definition at line 82 of file ff_error.h.

◆ FF_CREATEIOMAN

#define FF_CREATEIOMAN   (1 << FF_FUNCTION_SHIFT) | FF_MODULE_IOMAN

Definition at line 73 of file ff_error.h.

◆ FF_DESTROYIOMAN

#define FF_DESTROYIOMAN   (2 << FF_FUNCTION_SHIFT) | FF_MODULE_IOMAN

Definition at line 74 of file ff_error.h.

◆ FF_ERR_DEVICE_DRIVER_FAILED

#define FF_ERR_DEVICE_DRIVER_FAILED   4

The Block Device driver reported a FATAL error, cannot continue.

Definition at line 96 of file ff_error.h.

◆ FF_ERR_DIR_CANT_EXTEND_ROOT_DIR

#define FF_ERR_DIR_CANT_EXTEND_ROOT_DIR   55

Can't extend the root dir.

Definition at line 136 of file ff_error.h.

◆ FF_ERR_DIR_DIRECTORY_FULL

#define FF_ERR_DIR_DIRECTORY_FULL   51

No more items could be added to the directory.

Definition at line 132 of file ff_error.h.

◆ FF_ERR_DIR_END_OF_DIR

#define FF_ERR_DIR_END_OF_DIR   52

Definition at line 133 of file ff_error.h.

◆ FF_ERR_DIR_EXTEND_FAILED

#define FF_ERR_DIR_EXTEND_FAILED   56

Not enough space to extend the directory.

Definition at line 137 of file ff_error.h.

◆ FF_ERR_DIR_INVALID_PATH

#define FF_ERR_DIR_INVALID_PATH   54

Could not find the directory specified by the path.

Definition at line 135 of file ff_error.h.

◆ FF_ERR_DIR_NAME_TOO_LONG

#define FF_ERR_DIR_NAME_TOO_LONG   57

Name exceeds the number of allowed charachters for a filename.

Definition at line 138 of file ff_error.h.

◆ FF_ERR_DIR_NOT_EMPTY

#define FF_ERR_DIR_NOT_EMPTY   53

Cannot delete a directory that contains files or folders.

Definition at line 134 of file ff_error.h.

◆ FF_ERR_DIR_OBJECT_EXISTS

#define FF_ERR_DIR_OBJECT_EXISTS   50

A file or folder of the same name already exists in the current directory.

Definition at line 131 of file ff_error.h.

◆ FF_ERR_FAT_NO_FREE_CLUSTERS

#define FF_ERR_FAT_NO_FREE_CLUSTERS   70

No more free space is available on the disk.

Definition at line 141 of file ff_error.h.

◆ FF_ERR_FILE_ALREADY_OPEN

#define FF_ERR_FILE_ALREADY_OPEN   30

File is in use.

Definition at line 117 of file ff_error.h.

◆ FF_ERR_FILE_COULD_NOT_CREATE_DIRENT

#define FF_ERR_FILE_COULD_NOT_CREATE_DIRENT   41

Definition at line 128 of file ff_error.h.

◆ FF_ERR_FILE_DESTINATION_EXISTS

#define FF_ERR_FILE_DESTINATION_EXISTS   38

Definition at line 125 of file ff_error.h.

◆ FF_ERR_FILE_DIR_NOT_FOUND

#define FF_ERR_FILE_DIR_NOT_FOUND   40

Definition at line 127 of file ff_error.h.

◆ FF_ERR_FILE_EXTEND_FAILED

#define FF_ERR_FILE_EXTEND_FAILED   37

Could not extend the file.

Definition at line 124 of file ff_error.h.

◆ FF_ERR_FILE_INVALID_PATH

#define FF_ERR_FILE_INVALID_PATH   34

The path of the file was not found.

Definition at line 121 of file ff_error.h.

◆ FF_ERR_FILE_IS_READ_ONLY

#define FF_ERR_FILE_IS_READ_ONLY   33

Tried to FF_Open() a file marked read only.

Definition at line 120 of file ff_error.h.

◆ FF_ERR_FILE_NOT_FOUND

#define FF_ERR_FILE_NOT_FOUND   31

File was not found.

Definition at line 118 of file ff_error.h.

◆ FF_ERR_FILE_NOT_OPENED_IN_READ_MODE

#define FF_ERR_FILE_NOT_OPENED_IN_READ_MODE   36

Definition at line 123 of file ff_error.h.

◆ FF_ERR_FILE_NOT_OPENED_IN_WRITE_MODE

#define FF_ERR_FILE_NOT_OPENED_IN_WRITE_MODE   35

Definition at line 122 of file ff_error.h.

◆ FF_ERR_FILE_OBJECT_IS_A_DIR

#define FF_ERR_FILE_OBJECT_IS_A_DIR   32

Tried to FF_Open() a Directory.

Definition at line 119 of file ff_error.h.

◆ FF_ERR_FILE_SOURCE_NOT_FOUND

#define FF_ERR_FILE_SOURCE_NOT_FOUND   39

Definition at line 126 of file ff_error.h.

◆ FF_ERR_IOMAN_ACTIVE_HANDLES

#define FF_ERR_IOMAN_ACTIVE_HANDLES   20

The partition cannot be unmounted until all active file handles are closed. (There may also be active handles on the cache).

Definition at line 109 of file ff_error.h.

◆ FF_ERR_IOMAN_BAD_BLKSIZE

#define FF_ERR_IOMAN_BAD_BLKSIZE   11

The provided blocksize was not a multiple of 512.

Definition at line 100 of file ff_error.h.

◆ FF_ERR_IOMAN_BAD_MEMSIZE

#define FF_ERR_IOMAN_BAD_MEMSIZE   12

The memory size was not a multiple of the blocksize.

Definition at line 101 of file ff_error.h.

◆ FF_ERR_IOMAN_DEV_ALREADY_REGD

#define FF_ERR_IOMAN_DEV_ALREADY_REGD   13

Device was already registered. Use FF_UnRegister() to re-use this IOMAN with another device.

Definition at line 102 of file ff_error.h.

◆ FF_ERR_IOMAN_DEV_INVALID_BLKSIZE

#define FF_ERR_IOMAN_DEV_INVALID_BLKSIZE   18

IOMAN object BlkSize is not compatible with the blocksize of this device driver.

Definition at line 107 of file ff_error.h.

◆ FF_ERR_IOMAN_GPT_HEADER_CORRUPT

#define FF_ERR_IOMAN_GPT_HEADER_CORRUPT   21

The GPT partition table appears to be corrupt, refusing to mount.

Definition at line 110 of file ff_error.h.

◆ FF_ERR_IOMAN_INVALID_FORMAT

#define FF_ERR_IOMAN_INVALID_FORMAT   15

The.

Definition at line 104 of file ff_error.h.

◆ FF_ERR_IOMAN_INVALID_PARTITION_NUM

#define FF_ERR_IOMAN_INVALID_PARTITION_NUM   16

The partition number provided was out of range.

Definition at line 105 of file ff_error.h.

◆ FF_ERR_IOMAN_NO_MOUNTABLE_PARTITION

#define FF_ERR_IOMAN_NO_MOUNTABLE_PARTITION   14

A mountable partition could not be found on the device.

Definition at line 103 of file ff_error.h.

◆ FF_ERR_IOMAN_NOT_ENOUGH_FREE_SPACE

#define FF_ERR_IOMAN_NOT_ENOUGH_FREE_SPACE   22

Definition at line 111 of file ff_error.h.

◆ FF_ERR_IOMAN_NOT_FAT_FORMATTED

#define FF_ERR_IOMAN_NOT_FAT_FORMATTED   17

The partition did not look like a FAT partition.

Definition at line 106 of file ff_error.h.

◆ FF_ERR_IOMAN_OUT_OF_BOUNDS_READ

#define FF_ERR_IOMAN_OUT_OF_BOUNDS_READ   23

Definition at line 112 of file ff_error.h.

◆ FF_ERR_IOMAN_OUT_OF_BOUNDS_WRITE

#define FF_ERR_IOMAN_OUT_OF_BOUNDS_WRITE   24

Definition at line 113 of file ff_error.h.

◆ FF_ERR_IOMAN_PARTITION_MOUNTED

#define FF_ERR_IOMAN_PARTITION_MOUNTED   19

Device is in use by an actively mounted partition. Unmount the partition first.

Definition at line 108 of file ff_error.h.

◆ FF_ERR_NONE

#define FF_ERR_NONE   0

No Error.

Definition at line 92 of file ff_error.h.

◆ FF_ERR_NOT_ENOUGH_MEMORY

#define FF_ERR_NOT_ENOUGH_MEMORY   3

malloc() failed! - Could not allocate handle memory.

Definition at line 95 of file ff_error.h.

◆ FF_ERR_NULL_POINTER

#define FF_ERR_NULL_POINTER   2

pIoman was NULL.

Definition at line 94 of file ff_error.h.

◆ FF_ERR_UNICODE_CONVERSION_EXCEEDED

#define FF_ERR_UNICODE_CONVERSION_EXCEEDED   103

Filename exceeds MAX long-filename length when converted to UTF-16.

Definition at line 147 of file ff_error.h.

◆ FF_ERR_UNICODE_DEST_TOO_SMALL

#define FF_ERR_UNICODE_DEST_TOO_SMALL   101

Not enough space in the UTF-16 buffer to encode the entire sequence as UTF-16.

Definition at line 145 of file ff_error.h.

◆ FF_ERR_UNICODE_INVALID_CODE

#define FF_ERR_UNICODE_INVALID_CODE   100

An invalid Unicode charachter was provided!

Definition at line 144 of file ff_error.h.

◆ FF_ERR_UNICODE_INVALID_SEQUENCE

#define FF_ERR_UNICODE_INVALID_SEQUENCE   102

An invalid UTF-16 sequence was encountered.

Definition at line 146 of file ff_error.h.

◆ FF_FLUSHCACHE

#define FF_FLUSHCACHE   (7 << FF_FUNCTION_SHIFT) | FF_MODULE_IOMAN

Definition at line 79 of file ff_error.h.

◆ FF_FUNCTION_SHIFT

#define FF_FUNCTION_SHIFT   16

Definition at line 54 of file ff_error.h.

◆ FF_GETERROR

#define FF_GETERROR (   x)    (x & 0x0000FFFF)

Error codes are 32-bit numbers, and consist of three items: 8Bits 8bits 16bits ........ ........ ........ ........ [ModuleID][FunctionID][– ERROR CODE –]

Definition at line 51 of file ff_error.h.

◆ FF_GETPARTITIONBLOCKSIZE

#define FF_GETPARTITIONBLOCKSIZE   (8 << FF_FUNCTION_SHIFT) | FF_MODULE_IOMAN

Definition at line 80 of file ff_error.h.

◆ FF_MODULE_CRC

#define FF_MODULE_CRC   (5 << FF_MODULE_SHIFT)

Definition at line 61 of file ff_error.h.

◆ FF_MODULE_DIR

#define FF_MODULE_DIR   (2 << FF_MODULE_SHIFT)

Definition at line 58 of file ff_error.h.

◆ FF_MODULE_DRIVER

#define FF_MODULE_DRIVER   (13 << FF_MODULE_SHIFT)

Definition at line 69 of file ff_error.h.

◆ FF_MODULE_FAT

#define FF_MODULE_FAT   (4 << FF_MODULE_SHIFT)

Definition at line 60 of file ff_error.h.

◆ FF_MODULE_FILE

#define FF_MODULE_FILE   (3 << FF_MODULE_SHIFT)

Definition at line 59 of file ff_error.h.

◆ FF_MODULE_FORMAT

#define FF_MODULE_FORMAT   (6 << FF_MODULE_SHIFT)

Definition at line 62 of file ff_error.h.

◆ FF_MODULE_HASH

#define FF_MODULE_HASH   (7 << FF_MODULE_SHIFT)

Definition at line 63 of file ff_error.h.

◆ FF_MODULE_IOMAN

#define FF_MODULE_IOMAN   (1 << FF_MODULE_SHIFT)

Definition at line 57 of file ff_error.h.

◆ FF_MODULE_MEMORY

#define FF_MODULE_MEMORY   (8 << FF_MODULE_SHIFT)

Definition at line 64 of file ff_error.h.

◆ FF_MODULE_SAFETY

#define FF_MODULE_SAFETY   (11 << FF_MODULE_SHIFT)

Definition at line 67 of file ff_error.h.

◆ FF_MODULE_SHIFT

#define FF_MODULE_SHIFT   24

Definition at line 53 of file ff_error.h.

◆ FF_MODULE_STRING

#define FF_MODULE_STRING   (9 << FF_MODULE_SHIFT)

Definition at line 65 of file ff_error.h.

◆ FF_MODULE_TIME

#define FF_MODULE_TIME   (12 << FF_MODULE_SHIFT)

Definition at line 68 of file ff_error.h.

◆ FF_MODULE_UNICODE

#define FF_MODULE_UNICODE   (10 << FF_MODULE_SHIFT)

Definition at line 66 of file ff_error.h.

◆ FF_MOUNTPARTITION

#define FF_MOUNTPARTITION   (5 << FF_FUNCTION_SHIFT) | FF_MODULE_IOMAN

Definition at line 77 of file ff_error.h.

◆ FF_REGISTERBLKDEVICE

#define FF_REGISTERBLKDEVICE   (3 << FF_FUNCTION_SHIFT) | FF_MODULE_IOMAN

Definition at line 75 of file ff_error.h.

◆ FF_UNMOUNTPARTITION

#define FF_UNMOUNTPARTITION   (6 << FF_FUNCTION_SHIFT) | FF_MODULE_IOMAN

Definition at line 78 of file ff_error.h.

◆ FF_UNREGISTERBLKDEVICE

#define FF_UNREGISTERBLKDEVICE   (4 << FF_FUNCTION_SHIFT) | FF_MODULE_IOMAN

Definition at line 76 of file ff_error.h.

Function Documentation

◆ FF_GetErrMessage()

const FF_T_INT8 * FF_GetErrMessage ( FF_ERROR  iErrorCode)