FS_GetArchiveResource

Syntax


#include <nitro/fs.h>

BOOL FS_GetArchiveResource(const char *path, FSArchiveResource *resource);

Arguments

`path`	Path name that specifies an archive.
`resource`	FSArchiveResource structure that will store the resource information that is obtained.

Return Values

Returns TRUE if the resource information could be obtained properly; returns FALSE otherwise. In case of failure, the error details can be obtained using FS_GetArchiveResultCode().

Description

Gets the current resource information for the archive located at the specified path.

This function is used primarily to check for available space in FAT format archives. To determine the Save Data size of a NAND application, also see the information about the Save Data Size List.

Note

This function cannot be called from the interrupt handler (IRQ mode). Also note that in some cases processing may not end if interrupts are left prohibited.

Revision History

2009/01/13 Added a link to the Save Data Size List.
2007/12/17 Initial version.

CONFIDENTIAL