Files
ImmunityDebugger/1.73/Documentation/Ref/Libs.libheap.PHeap-class.html
2013-03-25 21:58:56 -04:00

428 lines
16 KiB
HTML
Executable File

<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>Libs.libheap.PHeap</title>
<link rel="stylesheet" href="epydoc.css" type="text/css" />
<script type="text/javascript" src="epydoc.js"></script>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Tree link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
<!-- Index link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
<!-- Help link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
<!-- Project homepage -->
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center"
>Immunity Debugger API Reference</th>
</tr></table></th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<span class="breadcrumbs">
Package&nbsp;Libs ::
<a href="Libs.libheap-module.html">Module&nbsp;libheap</a> ::
Class&nbsp;PHeap
</span>
</td>
<td>
<table cellpadding="0" cellspacing="0">
<!-- hide/show private -->
<tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
<tr><td align="right"><span class="options"
>[<a href="frames.html" target="_top">frames</a
>]&nbsp;|&nbsp;<a href="Libs.libheap.PHeap-class.html"
target="_top">no&nbsp;frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class PHeap</h1><p class="nomargin-top"><span class="codelink"><a href="Libs.libheap-pysrc.html#PHeap">source&nbsp;code</a></span></p>
<dl><dt>Known Subclasses:</dt>
<dd>
<ul class="subclass-list">
<li><a href="Libs.libheap.VistaPHeap-class.html">VistaPHeap</a></li> </ul>
</dd></dl>
<hr />
<!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Instance Methods</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-InstanceMethods"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">PHEAP object</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="__init__"></a><span class="summary-sig-name">__init__</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">imm</span>,
<span class="summary-sig-arg">heapddr</span>=<span class="summary-sig-default">0</span>,
<span class="summary-sig-arg">restore</span>=<span class="summary-sig-default">False</span>)</span><br />
Windows 32 Heap Class</td>
<td align="right" valign="top">
<span class="codelink"><a href="Libs.libheap-pysrc.html#PHeap.__init__">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="_grabHeap"></a><span class="summary-sig-name">_grabHeap</span>(<span class="summary-sig-arg">self</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="Libs.libheap-pysrc.html#PHeap._grabHeap">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="Libs.libheap.PHeap-class.html#printFreeListInUse" class="summary-sig-name">printFreeListInUse</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">uselog</span>=<span class="summary-sig-default">None</span>)</span><br />
Print the Heap's FreeListInUse bitmask</td>
<td align="right" valign="top">
<span class="codelink"><a href="Libs.libheap-pysrc.html#PHeap.printFreeListInUse">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="Libs.libheap.PHeap-class.html#printFreeList" class="summary-sig-name">printFreeList</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">uselog</span>=<span class="summary-sig-default">None</span>)</span><br />
Print the Heap's FreeList</td>
<td align="right" valign="top">
<span class="codelink"><a href="Libs.libheap-pysrc.html#PHeap.printFreeList">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">List of win32heapchunks</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="Libs.libheap.PHeap-class.html#getRestoredChunks" class="summary-sig-name">getRestoredChunks</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">address</span>)</span><br />
Enumerate Chunks of the current heap using a restore heap</td>
<td align="right" valign="top">
<span class="codelink"><a href="Libs.libheap-pysrc.html#PHeap.getRestoredChunks">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">win32heapchunks</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="Libs.libheap.PHeap-class.html#findChunkByAddress" class="summary-sig-name">findChunkByAddress</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">addr</span>)</span><br />
Find a Chunks by its address</td>
<td align="right" valign="top">
<span class="codelink"><a href="Libs.libheap-pysrc.html#PHeap.findChunkByAddress">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">List of win32heapchunks</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="Libs.libheap.PHeap-class.html#getChunks" class="summary-sig-name">getChunks</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">address</span>,
<span class="summary-sig-arg">size</span>=<span class="summary-sig-default">4294967295</span>)</span><br />
Enumerate Chunks of the current heap</td>
<td align="right" valign="top">
<span class="codelink"><a href="Libs.libheap-pysrc.html#PHeap.getChunks">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="get_chunk"></a><span class="summary-sig-name">get_chunk</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">addr</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="Libs.libheap-pysrc.html#PHeap.get_chunk">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></a>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Method Details</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-MethodDetails"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
</table>
<a name="printFreeListInUse"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">printFreeListInUse</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">uselog</span>=<span class="sig-default">None</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="Libs.libheap-pysrc.html#PHeap.printFreeListInUse">source&nbsp;code</a></span>&nbsp;
</td>
</tr></table>
<p>Print the Heap's FreeListInUse bitmask</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>uselog</code></strong> (Log Function) - (Optional, Def: Log Window) Log function that display the
information</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="printFreeList"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">printFreeList</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">uselog</span>=<span class="sig-default">None</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="Libs.libheap-pysrc.html#PHeap.printFreeList">source&nbsp;code</a></span>&nbsp;
</td>
</tr></table>
<p>Print the Heap's FreeList</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>uselog</code></strong> (Log Function) - (Optional, Def: Log Window) Log function that display the
information</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="getRestoredChunks"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">getRestoredChunks</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">address</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="Libs.libheap-pysrc.html#PHeap.getRestoredChunks">source&nbsp;code</a></span>&nbsp;
</td>
</tr></table>
<p>Enumerate Chunks of the current heap using a restore heap</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>address</code></strong> (DWORD) - Address where to start getting chunks</li>
</ul></dd>
<dt>Returns: List of win32heapchunks</dt>
<dd>Chunks</dd>
</dl>
</td></tr></table>
</div>
<a name="findChunkByAddress"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">findChunkByAddress</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">addr</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="Libs.libheap-pysrc.html#PHeap.findChunkByAddress">source&nbsp;code</a></span>&nbsp;
</td>
</tr></table>
<p>Find a Chunks by its address</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>address</code></strong> (DWORD) - Address to search for</li>
</ul></dd>
<dt>Returns: win32heapchunks</dt>
<dd>Chunk</dd>
</dl>
</td></tr></table>
</div>
<a name="getChunks"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">getChunks</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">address</span>,
<span class="sig-arg">size</span>=<span class="sig-default">4294967295</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="Libs.libheap-pysrc.html#PHeap.getChunks">source&nbsp;code</a></span>&nbsp;
</td>
</tr></table>
<p>Enumerate Chunks of the current heap</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>address</code></strong> (DWORD) - Address where to start getting chunks</li>
<li><strong class="pname"><code>size</code></strong> (DWORD) - (Optional, Def: All) Amount of chunks</li>
</ul></dd>
<dt>Returns: List of win32heapchunks</dt>
<dd>Chunks</dd>
</dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Tree link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
<!-- Index link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
<!-- Help link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
<!-- Project homepage -->
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center"
>Immunity Debugger API Reference</th>
</tr></table></th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
Generated by Epydoc 3.0.1 on Thu Sep 11 14:06:34 2008
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
>http://epydoc.sourceforge.net</a>
</td>
</tr>
</table>
<script type="text/javascript">
<!--
// Private objects are initially displayed (because if
// javascript is turned off then we want them to be
// visible); but by default, we want to hide them. So hide
// them unless we have a cookie that says to show them.
checkCookie();
// -->
</script>
</body>
</html>