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>MEMInitAllocatorForFrmHeap</TITLE>
12
13</HEAD>
14
15
16<BODY>
17
18
19<H1>MEMInitAllocatorForFrmHeap</H1>
20
21
22<H2>C Specification</H2>
23<PRE class="construction">#include &lt;revolution/mem.h&gt;
24
25void MEMInitAllocatorForFrmHeap(
26	 MEMAllocator*    pAllocator,
27	 MEMHeapHandle    heap,
28	 int     		  alignment);</PRE>
29
30
31<H2>Arguments</H2>
32<TABLE border="1">
33
34    <TR>
35	<TD><STRONG><EM><CODE>pAllocator</CODE></EM></STRONG></TD>
36	<TD>Address of the <CODE>MemAllocator</CODE> structure.</TD>
37</TR>
38    <TR>
39<TD><STRONG><EM><CODE>heap</CODE></EM></STRONG></TD>
40<TD>Frame heap handle.</TD>
41    </TR>
42    <TR>
43<TD><STRONG><EM><CODE>alignment</CODE></EM></STRONG></TD>
44<TD>Alignment value applied to each memory block to allocate.</TD>
45    </TR>
46  </TABLE>
47
48
49<H2>Return Values</H2>
50<P>None.</P>
51<H2>Description</H2>
52<P>This function initializes the allocator to allocate and free memory from the frame heap. The alignment values of all memory blocks allocated through this allocator are specified by <STRONG><EM><CODE>alignment</CODE></EM></STRONG>.</P>
53<P>Memory blocks can't be freed in block units for the frame heap, so the <A href="MEMFreeToAllocator.html"><code>MEMFreeToAllocator</code></A> function does nothing for allocators set to use the frame heap.</P>
54<H2>See Also</H2>
55<P class="reference"><CODE><A href="MEMInitAllocatorForExpHeap.html">MEMInitAllocatorForExpHeap</A>, <A href="MEMInitAllocatorForUnitHeap.html">MEMInitAllocatorForUnitHeap</A>, <A href="MEMInitAllocatorForOSHeap.html">MEMInitAllocatorForOSHeap</A></CODE></P>
56
57
58<H2>Revision History</H2>
59<P>03/01/2006 Initial version.</P>
60
61
62</BODY>
63</HTML>
64