FILEerase Function

Microchip MDD File System Interface

previous page next page

MDDFS Interface Library Help

FILEerase Function

CETYPE FILEerase(
    FILEOBJ fo, 
    WORD * fHandle, 
    BYTE EraseClusters
);

Description

This function will cache the sector of directory entries in the directory pointed to by the dirclus value in the FSFILE object 'fo' that contains the entry that corresponds to the fHandle offset. It will then mark that entry as deleted. If the EraseClusters argument is TRUE, the chain of clusters for that file will be marked as unused in the FAT by the FAT_erase_cluster_chain function.

Preconditions

This function should not be called by the user.

Parameters

Parameters	Description
fo	Pointer to file structure
fHandle	Location of file information
EraseClusters	Remove cluster allocation from FAT?

Return Values

Return Values	Description
CE_GOOD	File erased successfully
CE_FILE_NOT_FOUND	Could not find the file on the card
CE_ERASE_FAIL	Internal Card erase failed

Side Effects

None

Remarks

None.

APIs > File Manipulation Layer (FSIO) > Internal Members > FILEerase Function

Contents | Index | Home

previous page start next page