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_ClearOverlayImage</title>
9<LINK rel="stylesheet" href="../../css/nitro.css" type="text/css">
10</head>
11
12<body>
13
14<h1 align="left">FS_ClearOverlayImage <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> <BR> <CODE>BOOL FS_ClearOverlayImage(<A href="../fs_overlay_info_type.html">FSOverlayInfo</a> *p_ovi);</CODE><br> <br>
20  </dd>
21</dl>
22<h2>Arguments</h2>
23<TABLE border="1" width="100%">
24  <TBODY>
25    <TR>
26<TD width="13%"><EM><STRONG>p_ovi</STRONG></EM></TD>
27<TD width="87%"><code>FSOverlayInfo</code> structure that holds overlay module information.</TD>
28    </TR>
29  </TBODY>
30</TABLE>
31
32<h2>Return Values</h2>
33<p>Returns TRUE if the overlay module's region is cleared properly; returns FALSE otherwise.</p>
34
35<H2>Description</H2>
36<P>
37This function clears the overlay module's region. This function is called from the <code><a href="FS_LoadOverlayImage.html">FS_LoadOverlayImage</a></code> function. This process is equivalent to first disabling DTCM and ITCM starting at the address that is retrieved by the <code><a href="FS_GetOverlayAddress.html">FS_GetOverlayAddress</a></code> function, clearing the range retrieved by the <code><a href="FS_GetOverlayTotalSize.html">FS_GetOverlayTotalSize</a></code> function, and then initializing the entire region with a value of 0. This function is used with the <A><CODE>FS_GetOverlayFileID</CODE></A> function to asynchronously load overlays. 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>
38<h2>See Also</h2>
39<p><code><A href="../fs_overlay_info_type.html">FSOverlayInfo</A><BR> <A href="FS_LoadOverlayInfo.html">FS_LoadOverlayInfo</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_LoadOverlayImage.html">FS_LoadOverlayImage</A><BR> <A href="FS_LoadOverlay.html">FS_LoadOverlay</A><BR> <A href="FS_UnloadOverlayImage.html">FS_UnloadOverlayImage</A></code></p>
40
41<H2>Revision History</H2>
42<P>
432004/10/19 Changed the description and some links.<br> 2004/09/24 Added description concerning the relationship with each type of overlay function.<br> 2004/09/09 Initial version.
44</P>
45<hr><p>CONFIDENTIAL</p></body>
46</html>
47