Real time embedded FreeRTOS RSS feed 
Real time embedded FreeRTOS mailing list 
Homepage FreeRTOS+ Products FreeRTOS Labs Integration Services 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 ]    [ FreeRTOS+ Sitemap ]    [ Main FreeRTOS Sitemap ]    [ ]


Copyright (C) 2004-2010 Richard Barry. Copyright (C) 2010-2016 Real Time Engineers Ltd.
Any and all data, files, source code, html content and documentation included in the FreeRTOSTM distribution or available on this site are the exclusive property of Real Time Engineers Ltd.. See the files license.txt (included in the distribution) and this copyright notice for more information. FreeRTOSTM and FreeRTOS.orgTM are trade marks of Real Time Engineers Ltd.