Previous

Next

Function RTFCheckDisk

RTFCheckDisk checks and optionally fixes file system errors on a FAT or exFAT formatted logical drive:

typedef DWORD (__cdecl * RTFCheckDiskCallback)(DWORD                  Flag, 
                                               const char           * Path, 
                                               const RTFDOSDirEntry * FileInfo, 
                                               DWORD                  N1, 
                                               DWORD                  N2); 

int RTFCheckDisk(const char         * DriveName, 
                 void               * Buffer, 
                 UINT                 BufferSize, 
                 RTFCheckDiskCallback ErrorHandler, 
                 DWORD                Flags);

Parameters

DriveName

Pointer to a valid file name (e.g., a root directory such as "C:\"). Only the name's drive information is evaluated.

Buffer

Pointer to temporary storage RTFCheckDisk can use. Parameter BufferSize specifies how large the buffer is. If this parameter or BufferSize is 0, RTFCheckDisk allocates the required buffer from the heap.

BufferSize

Size in bytes of the buffer pointed to by parameter Buffer. This parameter should be equal to or larger than the value returned by function RTFCheckDiskBufferSize. If this parameter or Buffer is 0, RTFCheckDisk allocates the required buffer from the heap.

ErrorHandler

Callback function RTFCheckDisk will call for progress information or when a problem has been detected. This parameter may be NULL if RTFCheckDisk should always apply the default fix method and no progress information is required. More information about the error handler callback is given below.

Flags

The Flags parameter specifies which checks and fix method (if any) are to be applied. At most one flag out of each group in the list below may be specified. Note that if several checks are specified, they are performed in the sequence given below:

return value

If the function succeeds, the return value is RTF_NO_ERROR. If it fails, the return value is a negative error code. Note that RTF_NO_ERROR is also returned if errors have been found. An error is only returned if RTFCheckDisk was unable to complete, for example, due to a device driver error or the operation was aborted.

When RTFCheckDisk detects a file system error, it will call the ErrorHandler callback supplied by the application. The error handler can then decide if and how the error is to be fixed. The Flags parameter to the error handler corresponds to the Flags parameter passed to RTFCheckDisk with all flags of other checks masked out. The error handler must return the Flags value which RTFCheckDisk should use to fix (or not fix) the error. If it merely returns the Flags value passed to it, the default fix strategy as specified in the RTFCheckDisk call will be applied. This is the behavior RTFCheckDisk exhibits when a NULL error handler is supplied. Return value 0 can always be used if no fix is to be applied.

An error handler receives additional information about the error passed as parameters. It can, for example, display this information to the user and prompt for a fix strategy. The error handler's parameter interpretation depends on the error being reported:

checking FAT... 
searching lost clusters...

Demo programs RTFCmd and RTFCmdMT use RTFCheckDisk with a custom error handler.

Function RTFFormatExFAT

Function RTFCheckDiskBufferSize