Quality RTOS & Embedded Software

LIBRARIES
WHAT'S NEW
FreeRTOS:
AWS Reference Integrations:
FreeRTOS SMP:
Embedded World track keynote:

f_findfirst()

[FreeRTOS Embedded File System API]

header_file.h
unsigned char f_findfirst( const char *pcFileName, F_FIND *pxFindStruct );
		

Finds the first file or directory in a FAT file system directory. Call f_findfirst() to find the first file or directory, then f_findnext() to find subsequent files and directories.

Parameters:

pcFileName   Name/path of the files to find (see the example below).

pxFindStruct   A structure in which the 'find' information is stored.

Returns:
F_NO_ERROR   The call to f_findfirst() was successful and pxFindStruct was populated.

Any other value   The call to f_findfirst() was not successful. The return value holds the error code.

See also

f_findnext().

Example usage:


void vAFunction( void )
{
F_FIND xFindStruct;

/* Print out information on every file in the subdirectory "subdir". */
if( f_findfirst( "/subdir/*.*", &xFindStruct ) == F_NO_ERROR )
{
do
{
printf( filename:%s, xFindStruct.filename );

if( ( xFindStruct.attr & F_ATTR_DIR ) != 0 )
{
printf ( "is a directory directoryrn" );
}
else
{
printf ( "is a file of size %drn", xFindStruct.filesize );
}

} while( f_findnext( &xFindStruct ) == F_NO_ERROR );
}
}

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