Real time embedded FreeRTOS RSS feed 
Homepage FreeRTOS+ Products FreeRTOS Labs Support Forum Contact / Enquiries

f_delete()

[FreeRTOS Embedded File System API]

header_file.h
unsigned char f_delete( const char *pcFileName );
		

Delete a file or directory from the FAT file system.

A file or directory cannot be deleted if it is open or marked as read only.

Parameters:

pcFileName   The name (with or without path) of the file or directory that is being deleted. The name is specified as a standard null terminated C string.

Returns:
F_NO_ERROR   The file or directory was deleted.

Any other value   The file or directory was not deleted. The return value holds the error code.

See also

f_mkdir().

Example usage:


void vExampleFunction( void )
{
    /* Delete the file named "file.txt" from the subdir directory. */
    f_delete( "a:/subdir/file.txt" );
}
						
Example use of the f_delete() API function


[ Back to the top ]    [ About FreeRTOS ]    [ Privacy ]    [ FreeRTOS+ Sitemap ]    [ Main FreeRTOS Sitemap ]    [ ]


Copyright (C) Amazon Web Services, Inc. or its affiliates. All rights reserved.