SdFs Class Reference

SD file system class for FAT16, FAT32, and exFAT volumes. More...

#include <SdFat.h>

Inherits SdBase< FsVolume >.

Public Member Functions
bool	format (print_t *pr=nullptr)
Public Member Functions inherited from SdBase< FsVolume >
bool	begin (SdCsPin_t csPin=SS)
SdCard *	card ()
bool	cardBegin (SdSpiConfig spiConfig)
void	errorHalt (print_t *pr)
void	initErrorHalt (print_t *pr)
void	initErrorPrint (Print *pr)
void	printFatType (print_t *pr)
void	errorPrint (print_t *pr)
void	printSdError (print_t *pr)
uint8_t	sdErrorCode ()
uint8_t	sdErrorData ()
FsVolume *	vol ()
bool	volumeBegin ()
Public Member Functions inherited from FsVolume
	FsVolume ()
	~FsVolume ()
bool	begin (BlockDevice *blockDev)
uint32_t	blocksPerCluster () __attribute__((deprecated))
uint32_t	bytesPerCluster () const
bool	chdir ()
bool	chdir (const char *path)
void	chvol ()
uint32_t	clusterCount () const
uint32_t	dataStartSector () const
void	end ()
bool	exists (const char *path)
uint32_t	fatStartSector () const
uint8_t	fatType () const
uint32_t	freeClusterCount () const
bool	isBusy ()
bool	ls (print_t *pr)
bool	ls (print_t *pr, uint8_t flags)
bool	ls (print_t *pr, const char *path, uint8_t flags)
bool	mkdir (const char *path, bool pFlag=true)
FsFile	open (const char *path, oflag_t oflag=O_RDONLY)
bool	remove (const char *path)
bool	rename (const char *oldPath, const char *newPath)
bool	rmdir (const char *path)
uint32_t	sectorsPerCluster () const
bool	ls ()
bool	ls (uint8_t flags)
bool	ls (const char *path, uint8_t flags=0)
bool	chdir (const String &path)
bool	exists (const String &path)
bool	mkdir (const String &path, bool pFlag=true)
FsFile	open (const String &path, oflag_t oflag=O_RDONLY)
bool	remove (const String &path)
bool	rename (const String &oldPath, const String &newPath)
bool	rmdir (const String &path)

Additional Inherited Members
Protected Attributes inherited from FsVolume
newalign_t	m_volMem [FS_ALIGN_DIM(ExFatVolume, FatVolume)]

Detailed Description

SD file system class for FAT16, FAT32, and exFAT volumes.

Member Function Documentation

format()

bool SdFs::format ( print_t * pr = nullptr )

inline

Format a SD card FAT or exFAT.

Parameters

[in]

pr

Optional Print information.

Returns

true for success or false for failure.

---

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

• SdFat.h