# FS_GetPathInfo

## 構文

    #include <nitro/fs.h>

    BOOL FS_GetPathInfo(const char *path, FSPathInfo *info);

## 引数

path | 情報を取得したいファイルまたはディレクトリのパス名
info | 得られた情報を格納すべき`FSPathInfo`構造体へのポインタ

## 返り値

指定したパスのエントリ情報が正しく取得できればTRUEを、失敗すればFALSEを返します。
失敗時の詳細なエラーは`FS_GetArchiveResultCode()`で取得することができます。

## 説明

指定したファイルまたはディレクトリのエントリ情報を取得します。
この関数は、指定したパスがファイルまたはディレクトリのどちらかとして存在すればエントリ情報を取得してTRUEを返します。
以下の場合には失敗してFALSEを返します。

- 指定したパスにファイルもディレクトリも存在しない場合

TWL専用ファイルに関するエントリ情報はNITROモードで動作しているときでも取得することができます。実際にファイルへアクセス可能かどうかはattributesフィールドのFS_ATTRIBUTE_IS_OFFLINEフラグを確認することによって判定可能です。(TWL専用ファイルの指定についてはmakerom.TWLの"Put"パラメータに関する説明を参照してください)

## 注意

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

## 参照

`FSPathInfo
FS_GetArchiveResultCode`

## 履歴

2009/01/08 TWL専用ファイルに関する説明を追記
2007/12/13 初版