Real time embedded FreeRTOS RSS feed 
Real time embedded FreeRTOS mailing list 
Homepage FreeRTOS+ Products FreeRTOS Labs Integration Services Contact / Enquiries

f_rmdir()

[FreeRTOS Embedded File System API]

header_file.h
unsigned char f_rmdir( const char *pcDirectoryName );
		

Remove a directory from the embedded FAT file system. Only empty directories can be removed.

Parameters:

pcDirectoryName   The name of the directory being removed.

Returns:
F_NO_ERROR   The directory was removed (deleted).

Any other value   The directory was not removed (was not deleted). The return value holds the error code.

See also

f_chdir(), f_mkdir().

Example usage:


void vExampleFunction( void )
{
    /* Create a sub directory called subfolder, and sub directory within
    subfolder called sub1. */
    f_mkdir( "subfolder" );
    f_mkdir( "subfolder/sub1" );

    /* The directories can be accessed here. */

    /* Delete the two sub directories again. */
    f_rmdir( "subfolder/sub1" );
    f_rmdir( "subfolder" );
}
						
Example use of the f_rmdir() 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.