[ ]
Real time embedded FreeRTOS mailing list 
Homepage FreeRTOS Labs FreeRTOS+TCP FreeRTOS+FAT Contact / Enquiries


FreeRTOS+FAT is still in the lab
FreeRTOS+FAT is already in use in commercial products and we encourage you to try it yourself. Be aware however that FreeRTOS+FAT was acquired by Real Time Engineers Ltd., and is still being documented and updated to ensure it meets our strict quality standards. Please use the forum for support, or contact us directly if you have a specific business interest.

ff_remove()

[FreeRTOS+FAT Standard API Reference]

ff_stdio.h
int ff_remove( const char *pcPath );
		

Remove (delete, or unlink) a file from the embedded FAT file system. A file cannot be removed if it is open.

Parameters:

pcDirectory   A pointer to a standard null terminated C string that holds the name of the file being removed. The file name can include a relative path to the directory.

Returns:

If the file was removed successfully then zero is returned.

If the file could not be removed then NULL is returned and the task's errno is set to indicate the reason. A task can obtain its errno value using the ff_errno() API function. A file cannot be removed if it is open.

Example usage:


void vExampleFunction( void )
{
    /* Delete a file. */
    ff_remove( "/ram1/filename.txt" );
}
						
Example use of the ff_remove() API function to delete a file



[ Back to the top ]    [ About FreeRTOS ]    [ FreeRTOS Labs Sitemap ]    [ Main FreeRTOS Sitemap ]    [ ]




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