FS_LoadTable


C Specification

#include <nitro/fs.h>

BOOL FS_LoadTable( void *p_mem, u32 size );

Description

This function increases access efficiency by preloading all of the data in the tables that the file system frequently accesses internally into memory.

If the specified memory size is sufficient to hold the tables, this function will load all of the table data into memory. This memory will be used internally for subsequent file access. Therefore, users will not be able to use it.

This function will not perform any action if the specified memory size is insufficient. In such a situation, the specified memory will not be used and will be returned to the user.

To obtain a sufficient memory size for the tables, use the FS_GetTableSize function.

Caution

This function cannot be called from the interrupt handler (IRQ mode). Note that the process may not be completed if interrupts are prohibited.

Arguments

p_mem Pointer to the memory that a user prepares for tables.
size Memory size in bytes

Return Values

If table load succeeds, a value of TRUE is returned. Otherwise, a value of FALSE is returned.

See Also

FS_GetTableSize

Revision History

09/24/2004 Added the description in the Caution section regarding the conditions for calling this function.
04/22/2004 Initial version