FS_ConvertPathToFileID

C Specification

#include <nitro/fs.h>

BOOL FS_ConvertPathToFileID( FSFileID *p_file_id, const char *path );

Arguments

p_file_id Address of the FSFileID structure that holds results.
path File's path name

Return Values

If the file ID is correctly acquired, it returns a value of TRUE. Otherwise it returns a value of FALSE.

Description

This function acquires the file ID from the specified path name. You can open a file by specifying this file ID when you call the FS_OpenFileFast function. For information on the path name format, see the definition of the FS_OpenFile function.

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.


See Also

FSFile, FSFileID, FS_OpenFileFast, FS_OpenFile

Revision History

11/02/2004 Added and corrected links.
09/24/2004 Added text under Caution regarding the conditions for calling this function.
05/20/2004 Initial version.