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 http-equiv="Content-Style-Type" content="text/css">
7<META name="GENERATOR" content="IBM WebSphere Studio Homepage Builder Version 8.0.0.0 for Windows">
8
9<LINK rel="stylesheet" type="text/css" href="../../CSS/revolution.css">
10
11	<TITLE>MEMCreateUnitHeap</TITLE>
12
13</HEAD>
14
15
16<BODY>
17
18
19<H1>MEMCreateUnitHeap</H1>
20
21<H2>Syntax</H2>
22<DL><DD><PRE class="construction">
23#include &lt;revolution/mem.h&gt;
24
25MEMHeapHandle MEMCreateUnitHeap(
26                             void*  startAddress,
27                             u32    heapSize,
28                             u32    memBlockSize );
29</PRE></DD></DL>
30
31<H2>Arguments</H2>
32<TABLE class="arguments" border="1">
33  <TR>
34<TH><STRONG><EM><CODE>startAddress</CODE></EM></STRONG></TH>
35<TD>Start address of the memory region to allocate to the heap</TD>
36  </TR>
37  <TR>
38<TH><STRONG><EM><CODE>heapSize</CODE></EM></STRONG></TH>
39<TD>Size in bytes of the memory region allocated to the heap</TD>
40  </TR>
41  <TR>
42<TH><STRONG><EM><CODE>memBlockSize</CODE></EM></STRONG></TH>
43<TD>Size of the memory block in bytes</TD>
44  </TR>
45</TABLE>
46
47<H2>Return Values</H2>
48<P>Returns the heap handle when a heap was successfully created. Returns <CODE>MEM_HEAP_INVALID_HANDLE</CODE> (a null value) if a heap could not be created.</P>
49
50<H2>Description</H2>
51<P>Creates the unit heap. The heap region is a memory region with size <SPAN class="argument">heapSize</SPAN> and a start address specified by <SPAN class="argument">startAddress</SPAN>.</P>
52<P>Each memory block has a fixed size specified by <SPAN class="argument">memBlockSize</SPAN>. The memory block alignment is 4.</P>
53
54<H2>See Also</H2>
55<P class="reference">
56<A href="MEMCreateUnitHeapEx.html">MEMCreateUnitHeapEx</A>
57</P>
58
59<H2>Revision History</H2>
60<P>
612006/03/01 Initial version.<BR>
62</P>
63
64<hr><p>CONFIDENTIAL</p></body>
65</HTML>
66