1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<html>
3
4<head>
5<META http-equiv="Content-Type" content="text/html; charset=windows-1252">
6<META name="GENERATOR" content="IBM WebSphere Studio Homepage Builder Version 7.0.0.0 for Windows">
7<META http-equiv="Content-Style-Type" content="text/css">
8<title>FS_LoadOverlayImageAsync</title>
9<LINK rel="stylesheet" href="../../css/nitro.css" type="text/css">
10</head>
11
12<body>
13
14<h1 align="left">FS_LoadOverlayImageAsync <img src="../../image/NTR.gif"align="middle"><img src="../../image/TWL.gif" align="middle"></h1>
15<h2>Syntax</h2>
16
17<dl>
18  <dd>
19<CODE>#include &lt;nitro/fs.h&gt;</CODE><BR>
20  <BR>
21  <CODE>BOOL FS_LoadOverlayImageAsync(<A href="../fs_overlay_info_type.html">FSOverlayInfo</a> *p_ovi, <A href="../fs_file_type.html">FSFile</a> *p_file);</CODE><br>
22  <br>
23  </dd>
24</dl>
25<h2>Arguments</h2>
26<TABLE border="1" width="100%">
27  <TBODY>
28    <TR>
29      <TD width="13%"><EM><STRONG>p_ovi</STRONG></EM></TD>
30      <TD width="87%"><code>FSOverlayInfo</code> structure that holds overlay module information.</TD>
31    </TR>
32    <TR>
33      <TD width="13%"><EM><STRONG>p_file</STRONG></EM></TD>
34      <TD width="87%">Pointer to the <A href="../fs_file_type.html">FSFile</A> structure used for asynchronous reading.
35	  This structure's state must not indicate that a file is already open.
36	  Once this function succeeds and the read process ends, you must explicitly close the file using the <a href="../file/FS_CloseFile.html">FS_CloseFile</a> function.</TD>
37    </TR>
38  </TBODY>
39</TABLE>
40
41<h2>Return Values</h2>
42<p>Returns TRUE if the overlay module's load process started correctly; FALSE otherwise.</p>
43
44<H2>Description</H2>
45<P>This function asynchronously loads the image of an overlay module to memory. If this function succeeds, the specified <code>p_file</code> opens the file and enters the reading state. When the function waits for the read process to complete, it is equivalent to the <a href="FS_LoadOverlayImage.html">FS_LoadOverlayImage</a> function.<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> For information about the relationship with other overlay functions that perform equivalent processes, see the example stated in the reference for the <a href="FS_LoadOverlay.html"><code>FS_LoadOverlay</code></a> function. <BR>
46<h2>See Also</h2>
47<p><code><A href="../fs_overlay_info_type.html">FSOverlayInfo</A>, <A href="FS_LoadOverlayInfo.html">FS_LoadOverlayInfo</A>, <A href="FS_GetOverlayTotalSize.html">FS_GetOverlayTotalSize</A>, <A href="FS_GetOverlayAddress.html">FS_GetOverlayAddress</A>, <A href="FS_GetOverlayFileID.html">FS_GetOverlayFileID</A>, <A href="FS_LoadOverlayImage.html">FS_LoadOverlayImage</A>, <A href="FS_StartOverlay.html">FS_StartOverlay</A>, <A href="FS_UnloadOverlayImage.html">FS_UnloadOverlayImage</A> <A href="FS_LoadOverlay.html">FS_LoadOverlay</A>,</code></p>
48
49<H2>Revision History</H2>
50<P>
512004/11/17 Made corrections regarding <code>FS_RegisterOverlayToDebugger</code>, which has been eliminated.<BR>2004/11/16 Initial version.
52</P>
53<hr><p>CONFIDENTIAL</p></body>
54</html>
55