# FS_GetOverlayFileID

## 構文

  `#include <nitro/fs.h>`
  `FSFileID FS_GetOverlayFileID(const FSOverlayInfo *p_ovi);`

## 引数

p_ovi | オーバーレイモジュールの情報が格納されたFSOverlayInfo構造体

## 返り値

オーバーレイモジュールのイメージが格納されたファイルのIDを返します。

## 説明

オーバーレイモジュールのイメージが格納されたファイルのIDを取得します。
`FS_LoadOverlayInfo()` は内部的にこのファイルからイメージをロードします。
本関数が返すIDを使用してオープンしたファイルはディレクトリ階層にありませんので、
`FS_GetPathName()` を呼び出しても失敗することに注意してください。
`FS_GetOverlayAddress()` で得られるアドレスを
`FS_ClearOverlayImage()` で初期化した後に
この関数で取得したファイルIDを使用してファイルを直接読み込むことにより、
オーバーレイのロードを非同期に行うことが可能です。

## 参照

`FSOverlayInfo
FS_LoadOverlayInfo FS_GetOverlayAddress FS_LoadOverlayImage FS_GetOverlayAddress FS_StartOverlay`

## 履歴

2004/11/17 `FS_RegisterOverlayToDebugger()` 廃止に関する記述修正
2004/10/19 `FS_RegisterOverlayToDebugger()` に関する記述追加
2004/06/11 初版