FS_GetPathLength


C Specification

#include 
s32 FS_GetPathLength( FSFile *p_file );

Description

This function acquires the length of the path name (including the terminating character "\0") of the specified file or directory. If you prepare at least as much memory as the return value before calling the FS_GetPathName() function, it will always succeed.

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_file FSFile structure's address

Return Values

If it succeeds, it returns the length of the path name, including the terminating character "\0". If it fails, it returns a value of -1.

See Also

FS_GetPathName

Revision History

09/24/2004 Added the description in the Caution section regarding the conditions for calling this function.
06/15/2004 Changed terminating NUL to terminating character "\0".
05/19/2004 Initial version