FS_ConvertPathToFileID

Syntax

#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 its file ID when you call the FS_OpenFileFast function. For more information on path name formatting, see the description of the FS_OpenFileEx 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_OpenFileEx

Revision History

2008/10/02 Updated the See Also list.
2004/11/02 Corrected links.
2004/09/24 Added text under Note regarding the conditions for calling this function.
2004/05/20 Initial version.

CONFIDENTIAL