blob: bd07b643eac344d7d27976a60ac30ee24c08641e [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.18"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Crashpad: crashpad::CrashpadInfoReader Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="crashpad_doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Crashpad
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.18 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespacecrashpad.html">crashpad</a></li><li class="navelem"><a class="el" href="classcrashpad_1_1CrashpadInfoReader.html">CrashpadInfoReader</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classcrashpad_1_1CrashpadInfoReader-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">crashpad::CrashpadInfoReader Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Reads <a class="el" href="structcrashpad_1_1CrashpadInfo.html" title="A structure that can be used by a Crashpad-enabled program to provide information to the Crashpad cra...">CrashpadInfo</a> structs from another process via a <a class="el" href="classcrashpad_1_1ProcessMemoryRange.html" title="Provides range protected access to the memory of another process.">ProcessMemoryRange</a>.
<a href="classcrashpad_1_1CrashpadInfoReader.html#details">More...</a></p>
<p><code>#include &quot;snapshot/crashpad_types/crashpad_info_reader.h&quot;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1CrashpadInfoReader_1_1InfoContainer.html">InfoContainer</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1CrashpadInfoReader_1_1InfoContainerSpecific.html">InfoContainerSpecific</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a0743328b5e89267c279be740ef8383c0"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1CrashpadInfoReader.html#a0743328b5e89267c279be740ef8383c0">Initialize</a> (const <a class="el" href="classcrashpad_1_1ProcessMemoryRange.html">ProcessMemoryRange</a> *memory, <a class="el" href="namespacecrashpad.html#af2d003bfc8632755c60ab27bd6d1c8ae">VMAddress</a> address)</td></tr>
<tr class="memdesc:a0743328b5e89267c279be740ef8383c0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializes this object. <a href="classcrashpad_1_1CrashpadInfoReader.html#a0743328b5e89267c279be740ef8383c0">More...</a><br /></td></tr>
<tr class="separator:a0743328b5e89267c279be740ef8383c0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
<tr class="memitem:a6924b8a17490e7a2dc2577ed934daab2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacecrashpad.html#a3b405c19a5787fabcfba96001d49f292">TriState</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1CrashpadInfoReader.html#a6924b8a17490e7a2dc2577ed934daab2">CrashpadHandlerBehavior</a> ()</td></tr>
<tr class="separator:a6924b8a17490e7a2dc2577ed934daab2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a240893f49525e362172dc73f3dc86e94"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacecrashpad.html#a3b405c19a5787fabcfba96001d49f292">TriState</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1CrashpadInfoReader.html#a240893f49525e362172dc73f3dc86e94">SystemCrashReporterForwarding</a> ()</td></tr>
<tr class="separator:a240893f49525e362172dc73f3dc86e94"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a50617d749da8c8138f46604808a7b35e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacecrashpad.html#a3b405c19a5787fabcfba96001d49f292">TriState</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1CrashpadInfoReader.html#a50617d749da8c8138f46604808a7b35e">GatherIndirectlyReferencedMemory</a> ()</td></tr>
<tr class="separator:a50617d749da8c8138f46604808a7b35e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a29084204d0fc1f672e59896b77e1201c"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1CrashpadInfoReader.html#a29084204d0fc1f672e59896b77e1201c">IndirectlyReferencedMemoryCap</a> ()</td></tr>
<tr class="separator:a29084204d0fc1f672e59896b77e1201c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9cdff522054aa10575484489345e2617"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacecrashpad.html#af2d003bfc8632755c60ab27bd6d1c8ae">VMAddress</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1CrashpadInfoReader.html#a9cdff522054aa10575484489345e2617">ExtraMemoryRanges</a> ()</td></tr>
<tr class="separator:a9cdff522054aa10575484489345e2617"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9c8c8e0299c4a4b746b8221542345f79"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacecrashpad.html#af2d003bfc8632755c60ab27bd6d1c8ae">VMAddress</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1CrashpadInfoReader.html#a9c8c8e0299c4a4b746b8221542345f79">SimpleAnnotations</a> ()</td></tr>
<tr class="separator:a9c8c8e0299c4a4b746b8221542345f79"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae50a840bbb322a0fe91ba23ef5561602"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacecrashpad.html#af2d003bfc8632755c60ab27bd6d1c8ae">VMAddress</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1CrashpadInfoReader.html#ae50a840bbb322a0fe91ba23ef5561602">AnnotationsList</a> ()</td></tr>
<tr class="separator:ae50a840bbb322a0fe91ba23ef5561602"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa5192b500dbdad9a9b3bc1465111b918"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacecrashpad.html#af2d003bfc8632755c60ab27bd6d1c8ae">VMAddress</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1CrashpadInfoReader.html#aa5192b500dbdad9a9b3bc1465111b918">UserDataMinidumpStreamHead</a> ()</td></tr>
<tr class="separator:aa5192b500dbdad9a9b3bc1465111b918"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Reads <a class="el" href="structcrashpad_1_1CrashpadInfo.html" title="A structure that can be used by a Crashpad-enabled program to provide information to the Crashpad cra...">CrashpadInfo</a> structs from another process via a <a class="el" href="classcrashpad_1_1ProcessMemoryRange.html" title="Provides range protected access to the memory of another process.">ProcessMemoryRange</a>. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="ae50a840bbb322a0fe91ba23ef5561602"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae50a840bbb322a0fe91ba23ef5561602">&#9670;&nbsp;</a></span>AnnotationsList()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespacecrashpad.html#af2d003bfc8632755c60ab27bd6d1c8ae">VMAddress</a> crashpad::CrashpadInfoReader::AnnotationsList </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section see"><dt>See also</dt><dd><a class="el" href="structcrashpad_1_1CrashpadInfo.html" title="A structure that can be used by a Crashpad-enabled program to provide information to the Crashpad cra...">CrashpadInfo</a> </dd></dl>
</div>
</div>
<a id="a6924b8a17490e7a2dc2577ed934daab2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6924b8a17490e7a2dc2577ed934daab2">&#9670;&nbsp;</a></span>CrashpadHandlerBehavior()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespacecrashpad.html#a3b405c19a5787fabcfba96001d49f292">TriState</a> crashpad::CrashpadInfoReader::CrashpadHandlerBehavior </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section see"><dt>See also</dt><dd><a class="el" href="structcrashpad_1_1CrashpadInfo.html" title="A structure that can be used by a Crashpad-enabled program to provide information to the Crashpad cra...">CrashpadInfo</a> </dd></dl>
</div>
</div>
<a id="a9cdff522054aa10575484489345e2617"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9cdff522054aa10575484489345e2617">&#9670;&nbsp;</a></span>ExtraMemoryRanges()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespacecrashpad.html#af2d003bfc8632755c60ab27bd6d1c8ae">VMAddress</a> crashpad::CrashpadInfoReader::ExtraMemoryRanges </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section see"><dt>See also</dt><dd><a class="el" href="structcrashpad_1_1CrashpadInfo.html" title="A structure that can be used by a Crashpad-enabled program to provide information to the Crashpad cra...">CrashpadInfo</a> </dd></dl>
</div>
</div>
<a id="a50617d749da8c8138f46604808a7b35e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a50617d749da8c8138f46604808a7b35e">&#9670;&nbsp;</a></span>GatherIndirectlyReferencedMemory()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespacecrashpad.html#a3b405c19a5787fabcfba96001d49f292">TriState</a> crashpad::CrashpadInfoReader::GatherIndirectlyReferencedMemory </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section see"><dt>See also</dt><dd><a class="el" href="structcrashpad_1_1CrashpadInfo.html" title="A structure that can be used by a Crashpad-enabled program to provide information to the Crashpad cra...">CrashpadInfo</a> </dd></dl>
</div>
</div>
<a id="a29084204d0fc1f672e59896b77e1201c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a29084204d0fc1f672e59896b77e1201c">&#9670;&nbsp;</a></span>IndirectlyReferencedMemoryCap()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t crashpad::CrashpadInfoReader::IndirectlyReferencedMemoryCap </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section see"><dt>See also</dt><dd><a class="el" href="structcrashpad_1_1CrashpadInfo.html" title="A structure that can be used by a Crashpad-enabled program to provide information to the Crashpad cra...">CrashpadInfo</a> </dd></dl>
</div>
</div>
<a id="a0743328b5e89267c279be740ef8383c0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0743328b5e89267c279be740ef8383c0">&#9670;&nbsp;</a></span>Initialize()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool crashpad::CrashpadInfoReader::Initialize </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classcrashpad_1_1ProcessMemoryRange.html">ProcessMemoryRange</a> *&#160;</td>
<td class="paramname"><em>memory</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespacecrashpad.html#af2d003bfc8632755c60ab27bd6d1c8ae">VMAddress</a>&#160;</td>
<td class="paramname"><em>address</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initializes this object. </p>
<p>This method must be successfully called bfore any other method in this class.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">memory</td><td>The reader for the remote process. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">address</td><td>The address in the remote process' address space of a <a class="el" href="structcrashpad_1_1CrashpadInfo.html" title="A structure that can be used by a Crashpad-enabled program to provide information to the Crashpad cra...">CrashpadInfo</a> struct. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><code>true</code> on success. <code>false</code> on failure with a message logged. </dd></dl>
</div>
</div>
<a id="a9c8c8e0299c4a4b746b8221542345f79"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9c8c8e0299c4a4b746b8221542345f79">&#9670;&nbsp;</a></span>SimpleAnnotations()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespacecrashpad.html#af2d003bfc8632755c60ab27bd6d1c8ae">VMAddress</a> crashpad::CrashpadInfoReader::SimpleAnnotations </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section see"><dt>See also</dt><dd><a class="el" href="structcrashpad_1_1CrashpadInfo.html" title="A structure that can be used by a Crashpad-enabled program to provide information to the Crashpad cra...">CrashpadInfo</a> </dd></dl>
</div>
</div>
<a id="a240893f49525e362172dc73f3dc86e94"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a240893f49525e362172dc73f3dc86e94">&#9670;&nbsp;</a></span>SystemCrashReporterForwarding()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespacecrashpad.html#a3b405c19a5787fabcfba96001d49f292">TriState</a> crashpad::CrashpadInfoReader::SystemCrashReporterForwarding </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section see"><dt>See also</dt><dd><a class="el" href="structcrashpad_1_1CrashpadInfo.html" title="A structure that can be used by a Crashpad-enabled program to provide information to the Crashpad cra...">CrashpadInfo</a> </dd></dl>
</div>
</div>
<a id="aa5192b500dbdad9a9b3bc1465111b918"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa5192b500dbdad9a9b3bc1465111b918">&#9670;&nbsp;</a></span>UserDataMinidumpStreamHead()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespacecrashpad.html#af2d003bfc8632755c60ab27bd6d1c8ae">VMAddress</a> crashpad::CrashpadInfoReader::UserDataMinidumpStreamHead </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section see"><dt>See also</dt><dd><a class="el" href="structcrashpad_1_1CrashpadInfo.html" title="A structure that can be used by a Crashpad-enabled program to provide information to the Crashpad cra...">CrashpadInfo</a> </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>snapshot/crashpad_types/crashpad_info_reader.h</li>
<li>snapshot/crashpad_types/crashpad_info_reader.cc</li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.18
</small></address>
</body>
</html>