1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<html>
3<head>
4<META http-equiv="Content-Type" content="text/html; charset=windows-1252">
5<META name="GENERATOR" content="IBM WebSphere Studio Homepage Builder Version 7.0.0.0 for Windows">
6<META http-equiv="Content-Style-Type" content="text/css">
7<title>FS_GetOverlayFileID</title>
8<LINK rel="stylesheet" href="../../css/nitro.css" type="text/css">
9</head>
10<body>
11<h1 align="left">FS_GetOverlayFileID <img src="../../image/NTR.gif"align="middle"><img src="../../image/TWL.gif" align="middle"></h1>
12<h2>Syntax</h2>
13<dl>
14  <dd>
15<CODE>#include &lt;nitro/fs.h&gt;</CODE><BR>
16  <BR>
17  <CODE>FSFileID FS_GetOverlayFileID(const <A href="../fs_overlay_info_type.html">FSOverlayInfo</a> *p_ovi);</CODE><br>
18  <br>
19  </dd>
20</dl>
21<h2>Arguments</h2>
22<TABLE border="1" width="100%">
23  <TBODY>
24    <TR>
25      <TD width="13%"><EM><STRONG>p_ovi</STRONG></EM></TD>
26      <TD width="87%"><code>FSOverlayInfo</code> structure that holds overlay module information.</TD>
27    </TR>
28  </TBODY>
29</TABLE>
30<h2>Return Values</h2>
31<p>Returns the ID of the file in which the image of the overlay module is stored.</p>
32<H2>Description</H2>
33<P>This function acquires the ID of the file in which the image of the overlay module has been stored. <code><A href="FS_LoadOverlayInfo.html">FS_LoadOverlayInfo</A></code> loads the image from this file internally. Note that the file that is opened using the ID that this function returns is not in the directory hierarchy. Therefore, a failure occurs when the <A href="../file/FS_GetPathName.html"><code>FS_GetPathName</code></A> function is called for this file. It is possible to load overlays asynchronously by loading the file using the file ID returned by this function after using <code><A href="FS_ClearOverlayImage.html">FS_ClearOverlayImage()</A></code> to initialize the address returned by <code><A href="FS_GetOverlayAddress.html">FS_GetOverlayAddress()</A></code>. <br>
34<h2>See Also</h2>
35<p><code><A href="../fs_overlay_info_type.html"><code>FSOverlayInfo</code></A><BR> <A href="FS_LoadOverlayInfo.html"><code>FS_LoadOverlayInfo</code></A><BR> <A href="FS_GetOverlayAddress.html"><code>FS_GetOverlayAddress</code></A><BR> <A href="FS_LoadOverlayImage.html"><code>FS_LoadOverlayImage</code></A><BR> <A href="FS_StartOverlay.html">FS_StartOverlay</A></code></p>
36<H2>Revision History</H2>
37<P>
382004/11/17 Revisions due to the elimination of the <code>FS_RegisterOverlayToDebugger</code> function.<BR>2004/10/19 Added description regarding the <code>FS_RegisterOverlayToDebugger</code> function.<BR>2004/06/11 Initial version.
39</P>
40<hr><p>CONFIDENTIAL</p></body>
41</html>
42