# FS_GetPathLength

## Syntax

  `#include <nitro/fs.h>`
  `s32 FS_GetPathLength( FSFile *p_file );`

## Arguments

p_file | Address of the `FSFile` structure.

## 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.

## Description

Gets 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 is guaranteed that the function will always succeed.

## 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

`FS_GetPathName`

## Revision History

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

CONFIDENTIAL