# FS_GetPathLength

## 構文

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

## 引数

p_file | FSFile構造体のアドレス

## 返り値

成功すれば終端文字 '\0' を含んだパス名の長さを返します。
失敗した場合は-1を返します。

## 説明

指定したファイルまたはディレクトリの、終端文字 '\0' を含んだパス名の長さを取得します。
この返り値以上のサイズでメモリを用意して `FS_GetPathName()`を呼べば
常に成功することが保証されます。

## 注意

この関数を割り込みハンドラ(IRQモード)から呼び出すことはできません。
また、割り込みを禁止したままの状態にあると処理が完了しない場合がある点に注意して下さい。

## 参照

`FS_GetPathName`

## 履歴

2004/09/24 呼び出し時および完了の条件についての注意を記述追加
2004/06/15 「終端のNUL」 を「終端文字 '\0'」に修正
2004/05/19 初版