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

f_initvolume()

[FreeRTOS Embedded File System API]

header_file.h
unsigned char f_initvolume( F_DRIVERINIT pxInitFunction );
		
Initialises the embedded FAT file system volume. f_initvolume() must be called before any file system operations can be performed.

f_initvolume() works independently of the status of the hardware, it does not matter if a card is inserted or not.

Parameters:

pxInitFunction   A pointer to the function used to initialise the drive.

Returns:

F_NO_ERROR   The drive was initialised successfully.

Any other value   The drive was not initialised successfully - the return value holds the error code.

See also:

f_format(), f_delvolume().

Example usage:


void vInitFAT( void )
{
unsigned char ucReturn;

    /* Initialise the drive */
    ucReturn = f_initvolume();
    if( ucReturn != F_NO_ERROR )
    {
        /* Volume was not initialised, ucReturn holds the error code. */
    }
    else
    {
        /* Volume was initialised. */
    }
}
						
Example use of the f_initvolume() 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.