# FS_GetPathName

## C Specification

  `#include <nitro/fs.h>`
  `BOOL FS_GetPathName( FSFile *p_file, char *buf, u32 len );`

## Arguments

`p_file` | Address of the `FSFile` structure
`buf` | Address of the buffer that holds the path name
`len` | Byte size of `buf`.

## Return Values

Returns a value of TRUE if it succeeds. Returns a value of FALSE if it fails.

## Description

This function acquires the path name (including the terminating character "\0") of the specified file or directory. If the file or directory is not valid, or if the buffer size is insufficient, it stores a value of FALSE without storing anything in the buffer.

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

## Revision History

11/02/2004 Corrected the name of an argument.
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.

CONFIDENTIAL