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_LoadOverlayImage</title>
8<LINK rel="stylesheet" href="../../css/nitro.css" type="text/css">
9</head>
10<body>
11<h1 align="left">FS_LoadOverlayImage <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>BOOL FS_LoadOverlayImage(<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 TRUE if the overlay module's image is loaded properly; FALSE otherwise.</p>
32<H2>Description</H2>
33<P>This function loads the image of an overlay module to memory. It will construct the &quot;raw initial state&quot; of the overlay module in memory. The subsequent running of the static initializer using the <A href="FS_StartOverlay.html"><code>FS_StartOverlay</code></A> function enables the overlay module.<br> <font color="#800000">When loading an overlay whose area conflicts with an existing loaded overlay, you must unload the previous overlay using the <code><A href="FS_UnloadOverlay.html">FS_UnloadOverlay</A></code> function.</font><br> This process is equivalent to calling the <A href="FS_LoadOverlayImageAsync.html"><code>FS_LoadOverlayImageAsync</code></A> function and waiting for the load process to finish. For information about the relationship with other overlay functions that perform equivalent processes, see the examples in the reference for the <code><A href="FS_LoadOverlay.html">FS_LoadOverlay</A></code> function. <BR>
34<h2>See Also</h2>
35<p><code><A href="../fs_overlay_info_type.html">FSOverlayInfo</A><br /> <A href="FS_LoadOverlay.html"><code>FS_LoadOverlay</code></A><br /> <A href="FS_LoadOverlayInfo.html">FS_LoadOverlayInfo</A><br /> <A href="FS_LoadOverlayImageAsync.html"><code>FS_LoadOverlayImageAsync</code></A><br /> <A href="FS_GetOverlayTotalSize.html">FS_GetOverlayTotalSize</A><br /> <A href="FS_GetOverlayAddress.html">FS_GetOverlayAddress</A><br /> <A href="FS_GetOverlayFileID.html">FS_GetOverlayFileID</A><br /> <A href="FS_StartOverlay.html">FS_StartOverlay</A><br /> <A href="FS_UnloadOverlayImage.html">FS_UnloadOverlayImage</A></code></p>
36<H2>Revision History</H2>
37<P>
382004/11/16 Added comparison to <code>FS_LoadOverlayImageAsync</code>, revised description of the process.<br>2004/10/19 Added description regarding the process contents.<br>2004/09/24 Added description concerning the relationship with each type of overlay function.<br>2004/06/11 Initial version.
39</P>
40<hr><p>CONFIDENTIAL</p></body>
41</html>
42