Quality RTOS & Embedded Software

LIBRARIES
WHAT'S NEW
FreeRTOS:
FreeRTOS LTS:
FreeRTOS:
FreeRTOS:
AWS Reference Integrations:

f_format()

[FreeRTOS Embedded File System API]

header_file.h
unsigned char f_format( unsigned char ucFATType );
		

Format the drive. Formatting a drive will close any files that were open and destroy any data that already exists on the drive, including the master boot record.

The formatted drive will start with boot sector information created from the information retrieved from the f_getphy() routine, and use the entire physical space for the volume.

The format operation will fail if the format type is incompatible with the size of the physical media.

Parameters:

ucFATType   The following values are valid:
  • F_FAT12_MEDIA to format as FAT12.
  • F_FAT16_MEDIA to format as FAT16.
  • F_FAT32_MEDIA to format as FAT32.

Returns:
F_NO_ERROR   The format operation was successful.

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

Example usage:


void vFormatDrive( void )
{
unsigned char ucReturned;

f_initvolume();

ucReturned = f_format( F_FAT16_MEDIA );
if( ucReturned != F_NO_ERROR )
{
/* The drive could not be formatted (is the disk in?). ucReturned
holds the error code. */

}
else
{
/* The drive was formatted successfully. */
}
}

Example use of the f_format() API function
Copyright (C) Amazon Web Services, Inc. or its affiliates. All rights reserved.