FileSystemObject Class Reference

#include <FileSystemObject.hpp>

Public Member Functions

const char * getDrivePath () const
 
char mount () const
 
FRESULT getDriveInfo (unsigned int *pTotalDriveSpaceKB, unsigned int *pAvailableSpaceKB) const
 
FRESULT format () const
 

Friends

class Storage
 Allow only the Storage class to create us. More...
 

Detailed Description

File System Class

Member Function Documentation

FRESULT FileSystemObject::format ( ) const
inline

Formats the drive with default allocation size

FRESULT FileSystemObject::getDriveInfo ( unsigned int *  pTotalDriveSpaceKB,
unsigned int *  pAvailableSpaceKB 
) const
inline

Get the drive's total capacity and available space

Parameters
pTotalDriveSpaceKBPointer where total drive space in kilobytes will be written
pAvailableSpaceKBPointer where drive's available space in kilobytes will be written
Note
The parameters will be written to zero if an error occurs during this operation.
const char* FileSystemObject::getDrivePath ( ) const
inline

Returns the root path of this drive, such as "0:" or "1:"

char FileSystemObject::mount ( ) const
inline

Initializes the disk and mounts the storage

Returns
TRUE if the disk is ready to be used.
Note
If disk is not formatted correctly, FILE IO may fail

Friends And Related Function Documentation

friend class Storage
friend

Allow only the Storage class to create us.


The documentation for this class was generated from the following file: