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.1.0 for Windows"> 6<META http-equiv="Content-Style-Type" content="text/css"> 7<TITLE>OS_FreeAll[To*]</TITLE> 8<LINK rel="stylesheet" href="../../css/nitro.css" type="text/css"> 9</HEAD> 10<BODY> 11<H1 align="left">OS_FreeAll[To*] <IMG src="../../image/NTR.gif" align="middle"><IMG src="../../image/TWL.gif" align="middle"></H1> 12<H2>Syntax</H2> 13<DL> 14 <DD> 15<PRE><CODE>#include <nitro/os.h></CODE></PRE> 16 <PRE><CODE>void OS_FreeAllToHeap( OSArenaId id, OSHeapHandle heap ); 17 18void OS_FreeAllToMain( void ); 19void OS_FreeAllToSubPriv( void ); 20void OS_FreeAllToMainEx( void ); 21void OS_FreeAllToITCM( void ); 22void OS_FreeAllToDTCM( void ); 23void OS_FreeAllToShared( void ); 24void OS_FreeAllToWramMain( void ); 25void OS_FreeAllToWramSub( void ); 26void OS_FreeAllToSubPrivWram( void ); 27 28void OS_FreeAll( void );</CODE></PRE> 29</DL> 30<H2>Arguments</H2> 31<TABLE border="1" width="100%"> 32 <TBODY> 33 <TR> 34<TD width="13%"><EM><STRONG>id</STRONG></EM></TD> 35<TD width="87%">Arena ID of the arena for the heap for which all memory blocks are being released.</TD> 36 </TR> 37 <TR> 38<TD><B><I>heap</I></B></TD> 39<TD>Handle of the heap from which all memory blocks are being freed.</TD> 40 </TR> 41 </TBODY> 42</TABLE> 43<H2>Return Values</H2> 44<P>None.</P> 45 46<H2>Description</H2> 47<P>Frees all allocated memory blocks and returns them to the heap specified by <CODE>heap</CODE>.</P> 48<P>You must specify an arena that has a heap. The arena is specified with the arena ID (<CODE>id</CODE>). To read more about this value, see the <a href="../arena/OS_InitArena.html"><code>OS_InitArena</code></a> function.</P> 49<P>Specifying <CODE>OS_CURRENT_HEAP_HANDLE</CODE> for <CODE>heap</CODE> is treated the same as if the arena's current heap had been specified.</P> 50<P><code>OS_FreeAllToMain</code> is the inline function for <code>OS_FreeAllToHeap( OS_ARENA_MAIN, OS_CURRENT_HEAP_HANDLE, ... )</code>.<br><code>OS_FreeAllToSubPriv</code> is the inline function for <code>OS_FreeAllToHeap( OS_ARENA_MAIN_SUBPRIV, OS_CURRENT_HEAP_HANDLE, ... )</code>.<br><code>OS_FreeAllToMainEx</code> is the inline function for <code>OS_FreeAllToHeap( OS_ARENA_MAINEX, OS_CURRENT_HEAP_HANDLE, ... )</code>.<br><code>OS_FreeAllToICTM</code> is the inline function for <code>OS_FreeAllToHeap( OS_ARENA_ITCM, OS_CURRENT_HEAP_HANDLE, ... )</code>.<br><code>OS_FreeAllToDTCM</code> is the function for of <code>OS_FreeAllToHeap( OS_ARENA_DTCM, OS_CURRENT_HEAP_HANDLE, ... )</code>.<br><code>OS_FreeAllToShared</code> is the inline function for <code>OS_FreeAllToHeap( OS_ARENA_SHARED, OS_CURRENT_HEAP_HANDLE, ... )</code>.<br><code>OS_FreeAllToWramMain</code> is the inline function for <code>OS_FreeAllToHeap( OS_ARENA_WRAM_MAIN, OS_CURRENT_HEAP_HANDLE, ... )</code>.<br><code>OS_FreeAllToWramSub</code> is the inline function for <code>OS_FreeAllToHeap( OS_ARENA_WRAM_SUB, OS_CURRENT_HEAP_HANDLE, ... )</code>.<br><code>OS_FreeAllToSubPrivWram</code> is the inline function for <code>OS_FreeAllToHeap( OS_ARENA_WRAM_SUBPRIV, OS_CURRENT_HEAP_HANDLE, ... )</code></P> 51<P>For ARM9, <code>OS_FreeAll</code> is the inline function for <CODE>OS_FreeAllToHeap( OS_ARENA_MAIN, OS_CURRENT_HEAP_HANDLE, ... )</CODE>.<br />For ARM7, <CODE>OS_FreeAll</CODE> is the inline function for <CODE>OS_FreeAllToHeap( OS_ARENA_MAIN_SUBPRIV, OS_CURRENT_HEA_HANDLE, ... )</CODE></P> 52<H2>See Also</H2> 53<P><a href="../arena/OS_InitArena.html"><CODE>OS_InitArena</CODE></a><BR> <a href="OS_AllocFromHeap.html"><CODE>OS_AllocFromHeap</CODE></a><BR> <a href="OS_FreeToHeap.html"><CODE>OS_FreeToHeap</CODE></a></P> 54<H2>Revision History</H2> 55<P>2004/11/05 Initial version.</P> 56<hr><p>CONFIDENTIAL</p></body> 57</HTML>
