# FS_GetPathName

## Syntax

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

Gets 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

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