FS_GetPathInfo

Syntax


#include <nitro/fs.h>

BOOL FS_GetPathInfo(const char *path, FSPathInfo *info);

Arguments

`path`	Path name of the file or directory that you want to get information about.
`info`	Pointer to the `FSPathInfo` structure where the obtained data should be stored.

Return Values

Returns TRUE if the entry information for the specified path was obtained properly; returns FALSE otherwise. In case of failure, the error details can be obtained using FS_GetArchiveResultCode().

Description

Gets the entry information for the specified file or directory. If there is a file or directory at the specified path, this function gets the entry information and returns TRUE.
The function fails and returns FALSE in the following situations:

When there is no file or directory at the specified path

The entry information for TWL-only files is available even when the system is operating in NITRO mode. You can determine whether access to the file is actually possible by checking the FS_ATTRIBUTE_IS_OFFLINE flag of the attributes field. (For more information on the specification of TWL-only files, see the explanation about the Put parameter in makerom.TWL.)

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/08 Added an explanation about TWL-only files.
2007/12/13 Initial version.

CONFIDENTIAL