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_UnloadOverlayImage</title>
9<LINK rel="stylesheet" href="../../css/nitro.css" type="text/css">
10</head>
11
12<body>
13
14<h1 align="left">FS_UnloadOverlayImage <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_UnloadOverlayImage(<A href="../fs_overlay_info_type.html">FSOverlayInfo</a> *p_ovi);</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  </TBODY>
33</TABLE>
34
35<h2>Return Values</h2>
36<p>Returns TRUE if the overlay module's image is unloaded properly; FALSE otherwise.</p>
37
38<H2>Description</H2>
39<P>This function unloads the image of an overlay module from memory. Currently, this function only calls the <code><a href="FS_EndOverlay.html">FS_EndOverlay</a></code> function internally. When loading an overlay module, this function must be called for all other loaded modules that contend for space. <BR>
40</p>
41<h2>See Also</h2>
42<p><code><A href="../fs_overlay_info_type.html">FSOverlayInfo</code></A>, <A href="FS_LoadOverlayInfo.html"><code>FS_LoadOverlayInfo</code></A>, <A href="FS_LoadOverlayImage.html"><code>FS_LoadOverlayImage</code></A>, <A href="FS_EndOverlay.html"><code>FS_EndOverlay</code></A></code></p>
43
44<H2>Revision History</H2>
45<P>
462004/11/02 Corrected a link.<BR> 2004/09/10 Added a description concerning <code>FS_EndOverlay()</code>.<BR>2004/06/1 Initial version.<BR>
47</P>
48<hr><p>CONFIDENTIAL</p></body>
49</html>
50