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_LoadOverlayInfo</title>
9<LINK rel="stylesheet" href="../../css/nitro.css" type="text/css">
10</head>
11
12<body>
13
14<h1 align="left">FS_LoadOverlayInfo <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_LoadOverlayInfo(<A href="../fs_overlay_info_type.html">FSOverlayInfo</a> *p_ovi, MIProcessor target, <A href="../fs_overlay_id_types.html">FSOverlayID</a> id);</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%">The <A href="../fs_overlay_info_type.html"><CODE>FSOverlayInfo</CODE></a> structure that holds overlay module information.</TD>
31    </TR>
32    <TR>
33      <TD width="13%"><EM><STRONG>target</STRONG></EM></TD>
34      <TD width="87%">Overlay module target (ARM9 processor/ARM7 processor)</TD>
35    </TR>
36    <TR>
37      <TD width="13%"><EM><STRONG>id</STRONG></EM></TD>
38      <TD width="87%">Overlay module ID</TD>
39    </TR>
40  </TBODY>
41</TABLE>
42
43<h2>Return Values</h2>
44<p>Returns a value of TRUE if the overlay module's information is loaded properly. Otherwise, a value of FALSE is returned.</p>
45
46<H2>Description</H2>
47<P>This function loads information that concerns an overlay module that is associated with a specified processor and a specified number. <BR>
48<h2>See Also</h2>
49<p><A href="../fs_overlay_info_type.html"><code>FSOverlayInfo</code></A>, <A href="../fs_overlay_id_types.html"><code>FSOverlayID</code></A>, <A href="../fs_overlay_id_types.html"><code>FS_OVERLAY_ID</code></A>, <A href="FS_GetOverlayTotalSize.html"><code>FS_GetOverlayTotalSize</code></A>, <A href="FS_GetOverlayImageSize.html"><code>FS_GetOverlayImageSize</code></A>, <A href="FS_GetOverlayAddress.html"><code>FS_GetOverlayAddress</code></A>, <A href="FS_GetOverlayFileID.html"><code>FS_GetOverlayFileID</code></A>, <A href="FS_LoadOverlayImage.html"><code>FS_LoadOverlayImage</code></A>, <A href="FS_StartOverlay.html"><code>FS_StartOverlay</code></A>, <A href="FS_UnloadOverlayImage.html"><code>FS_UnloadOverlayImage</code></A></p>
50
51<H2>Revision History</H2>
52<P>
532004/06/11 Initial version.
54</P>
55<hr><p>CONFIDENTIAL</p></body>
56</html>
57