blob: c71021569af5a942f851e4b7fa53a2ca528f7c2e [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::MinidumpModuleCrashpadInfo Struct 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="structcrashpad_1_1MinidumpModuleCrashpadInfo.html">MinidumpModuleCrashpadInfo</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="#pub-static-attribs">Static Public Attributes</a> &#124;
<a href="structcrashpad_1_1MinidumpModuleCrashpadInfo-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">crashpad::MinidumpModuleCrashpadInfo Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Additional Crashpad-specific information about a module carried within a minidump file.
<a href="structcrashpad_1_1MinidumpModuleCrashpadInfo.html#details">More...</a></p>
<p><code>#include &quot;minidump/minidump_extensions.h&quot;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:ace07d8872cdaa53ca20a04513deb56c3"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcrashpad_1_1MinidumpModuleCrashpadInfo.html#ace07d8872cdaa53ca20a04513deb56c3">version</a></td></tr>
<tr class="memdesc:ace07d8872cdaa53ca20a04513deb56c3"><td class="mdescLeft">&#160;</td><td class="mdescRight">The structure’s version number. <a href="structcrashpad_1_1MinidumpModuleCrashpadInfo.html#ace07d8872cdaa53ca20a04513deb56c3">More...</a><br /></td></tr>
<tr class="separator:ace07d8872cdaa53ca20a04513deb56c3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2ff38a7202adb5f8d3b8a3ede61ca4ec"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structMINIDUMP__LOCATION__DESCRIPTOR.html">MINIDUMP_LOCATION_DESCRIPTOR</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcrashpad_1_1MinidumpModuleCrashpadInfo.html#a2ff38a7202adb5f8d3b8a3ede61ca4ec">list_annotations</a></td></tr>
<tr class="memdesc:a2ff38a7202adb5f8d3b8a3ede61ca4ec"><td class="mdescLeft">&#160;</td><td class="mdescRight">A <a class="el" href="structcrashpad_1_1MinidumpRVAList.html" title="A list of RVA pointers.">MinidumpRVAList</a> pointing to <a class="el" href="structcrashpad_1_1MinidumpUTF8String.html" title="A variable-length UTF-8-encoded string carried within a minidump file.">MinidumpUTF8String</a> objects. The module controls the data that appears here. <a href="structcrashpad_1_1MinidumpModuleCrashpadInfo.html#a2ff38a7202adb5f8d3b8a3ede61ca4ec">More...</a><br /></td></tr>
<tr class="separator:a2ff38a7202adb5f8d3b8a3ede61ca4ec"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6d064fcc880ad2933443f9f27e5f434a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structMINIDUMP__LOCATION__DESCRIPTOR.html">MINIDUMP_LOCATION_DESCRIPTOR</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcrashpad_1_1MinidumpModuleCrashpadInfo.html#a6d064fcc880ad2933443f9f27e5f434a">simple_annotations</a></td></tr>
<tr class="memdesc:a6d064fcc880ad2933443f9f27e5f434a"><td class="mdescLeft">&#160;</td><td class="mdescRight">A <a class="el" href="structcrashpad_1_1MinidumpSimpleStringDictionary.html" title="A list of key-value pairs.">MinidumpSimpleStringDictionary</a> pointing to strings interpreted as key-value pairs. The module controls the data that appears here. <a href="structcrashpad_1_1MinidumpModuleCrashpadInfo.html#a6d064fcc880ad2933443f9f27e5f434a">More...</a><br /></td></tr>
<tr class="separator:a6d064fcc880ad2933443f9f27e5f434a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac200fe528c804f9047d990470b840dc9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structMINIDUMP__LOCATION__DESCRIPTOR.html">MINIDUMP_LOCATION_DESCRIPTOR</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcrashpad_1_1MinidumpModuleCrashpadInfo.html#ac200fe528c804f9047d990470b840dc9">annotation_objects</a></td></tr>
<tr class="memdesc:ac200fe528c804f9047d990470b840dc9"><td class="mdescLeft">&#160;</td><td class="mdescRight">A <a class="el" href="structcrashpad_1_1MinidumpAnnotationList.html" title="A list of annotation objects.">MinidumpAnnotationList</a> object containing the annotation objects stored within the module. The module controls the data that appears here. <a href="structcrashpad_1_1MinidumpModuleCrashpadInfo.html#ac200fe528c804f9047d990470b840dc9">More...</a><br /></td></tr>
<tr class="separator:ac200fe528c804f9047d990470b840dc9"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-attribs"></a>
Static Public Attributes</h2></td></tr>
<tr class="memitem:a47ff487dfe930f561edda132627bd7c0"><td class="memItemLeft" align="right" valign="top">static constexpr uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcrashpad_1_1MinidumpModuleCrashpadInfo.html#a47ff487dfe930f561edda132627bd7c0">kVersion</a> = 1</td></tr>
<tr class="memdesc:a47ff487dfe930f561edda132627bd7c0"><td class="mdescLeft">&#160;</td><td class="mdescRight">The structure’s currently-defined version number. <a href="structcrashpad_1_1MinidumpModuleCrashpadInfo.html#a47ff487dfe930f561edda132627bd7c0">More...</a><br /></td></tr>
<tr class="separator:a47ff487dfe930f561edda132627bd7c0"><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>Additional Crashpad-specific information about a module carried within a minidump file. </p>
<p>This structure augments the information provided by <a class="el" href="structMINIDUMP__MODULE.html" title="Information about a specific module loaded within the process at the time the snapshot was taken.">MINIDUMP_MODULE</a>. The minidump file must contain a module list stream (<a class="el" href="namespacecrashpad.html#a88363a45a4af1a16f542a8c1ff522ab9a226cb7d075ec01c79f233d098e9a9e3f" title="The stream type for MINIDUMP_MODULE_LIST.">kMinidumpStreamTypeModuleList</a>) in order for this structure to appear.</p>
<p>This structure is versioned. When changing this structure, leave the existing structure intact so that earlier parsers will be able to understand the fields they are aware of, and make additions at the end of the structure. Revise <a class="el" href="structcrashpad_1_1MinidumpModuleCrashpadInfo.html#a47ff487dfe930f561edda132627bd7c0" title="The structure’s currently-defined version number.">kVersion</a> and document each field’s validity based on <a class="el" href="structcrashpad_1_1MinidumpModuleCrashpadInfo.html#ace07d8872cdaa53ca20a04513deb56c3" title="The structure’s version number.">version</a>, so that newer parsers will be able to determine whether the added fields are valid or not.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="structcrashpad_1_1MinidumpModuleCrashpadInfoList.html" title="Additional Crashpad-specific information about modules carried within a minidump file.">MinidumpModuleCrashpadInfoList</a> </dd></dl>
</div><h2 class="groupheader">Member Data Documentation</h2>
<a id="ac200fe528c804f9047d990470b840dc9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac200fe528c804f9047d990470b840dc9">&#9670;&nbsp;</a></span>annotation_objects</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structMINIDUMP__LOCATION__DESCRIPTOR.html">MINIDUMP_LOCATION_DESCRIPTOR</a> crashpad::MinidumpModuleCrashpadInfo::annotation_objects</td>
</tr>
</table>
</div><div class="memdoc">
<p>A <a class="el" href="structcrashpad_1_1MinidumpAnnotationList.html" title="A list of annotation objects.">MinidumpAnnotationList</a> object containing the annotation objects stored within the module. The module controls the data that appears here. </p>
<p>These key-value pairs correspond to <a class="el" href="classcrashpad_1_1ModuleSnapshot.html#a373ec34033c8a1558060560871b29fe4" title="Returns the typed annotation objects recorded in the module.">ModuleSnapshot::AnnotationObjects()</a> and do not duplicate anything in <a class="el" href="structcrashpad_1_1MinidumpModuleCrashpadInfo.html#a2ff38a7202adb5f8d3b8a3ede61ca4ec" title="A MinidumpRVAList pointing to MinidumpUTF8String objects. The module controls the data that appears h...">list_annotations</a> or <a class="el" href="structcrashpad_1_1MinidumpModuleCrashpadInfo.html#a6d064fcc880ad2933443f9f27e5f434a" title="A MinidumpSimpleStringDictionary pointing to strings interpreted as key-value pairs....">simple_annotations</a>.</p>
<p>This field may be present when <a class="el" href="structcrashpad_1_1MinidumpModuleCrashpadInfo.html#ace07d8872cdaa53ca20a04513deb56c3" title="The structure’s version number.">version</a> is at least <code>1</code>. </p>
</div>
</div>
<a id="a47ff487dfe930f561edda132627bd7c0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a47ff487dfe930f561edda132627bd7c0">&#9670;&nbsp;</a></span>kVersion</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">constexpr uint32_t crashpad::MinidumpModuleCrashpadInfo::kVersion = 1</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">constexpr</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The structure’s currently-defined version number. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="structcrashpad_1_1MinidumpModuleCrashpadInfo.html#ace07d8872cdaa53ca20a04513deb56c3" title="The structure’s version number.">version</a> </dd></dl>
</div>
</div>
<a id="a2ff38a7202adb5f8d3b8a3ede61ca4ec"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2ff38a7202adb5f8d3b8a3ede61ca4ec">&#9670;&nbsp;</a></span>list_annotations</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structMINIDUMP__LOCATION__DESCRIPTOR.html">MINIDUMP_LOCATION_DESCRIPTOR</a> crashpad::MinidumpModuleCrashpadInfo::list_annotations</td>
</tr>
</table>
</div><div class="memdoc">
<p>A <a class="el" href="structcrashpad_1_1MinidumpRVAList.html" title="A list of RVA pointers.">MinidumpRVAList</a> pointing to <a class="el" href="structcrashpad_1_1MinidumpUTF8String.html" title="A variable-length UTF-8-encoded string carried within a minidump file.">MinidumpUTF8String</a> objects. The module controls the data that appears here. </p>
<p>These strings correspond to <a class="el" href="classcrashpad_1_1ModuleSnapshot.html#a11075b25729fda7cf96ed8c8b25061a2" title="Returns string annotations recorded in the module.">ModuleSnapshot::AnnotationsVector()</a> and do not duplicate anything in <a class="el" href="structcrashpad_1_1MinidumpModuleCrashpadInfo.html#a6d064fcc880ad2933443f9f27e5f434a" title="A MinidumpSimpleStringDictionary pointing to strings interpreted as key-value pairs....">simple_annotations</a> or <a class="el" href="structcrashpad_1_1MinidumpModuleCrashpadInfo.html#ac200fe528c804f9047d990470b840dc9" title="A MinidumpAnnotationList object containing the annotation objects stored within the module....">annotation_objects</a>.</p>
<p>This field is present when <a class="el" href="structcrashpad_1_1MinidumpModuleCrashpadInfo.html#ace07d8872cdaa53ca20a04513deb56c3" title="The structure’s version number.">version</a> is at least <code>1</code>. </p>
</div>
</div>
<a id="a6d064fcc880ad2933443f9f27e5f434a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6d064fcc880ad2933443f9f27e5f434a">&#9670;&nbsp;</a></span>simple_annotations</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structMINIDUMP__LOCATION__DESCRIPTOR.html">MINIDUMP_LOCATION_DESCRIPTOR</a> crashpad::MinidumpModuleCrashpadInfo::simple_annotations</td>
</tr>
</table>
</div><div class="memdoc">
<p>A <a class="el" href="structcrashpad_1_1MinidumpSimpleStringDictionary.html" title="A list of key-value pairs.">MinidumpSimpleStringDictionary</a> pointing to strings interpreted as key-value pairs. The module controls the data that appears here. </p>
<p>These key-value pairs correspond to <a class="el" href="classcrashpad_1_1ModuleSnapshot.html#a4d1328fda3e91a4c25369b5fcc4cf2f6" title="Returns key-value string annotations recorded in the module.">ModuleSnapshot::AnnotationsSimpleMap()</a> and do not duplicate anything in <a class="el" href="structcrashpad_1_1MinidumpModuleCrashpadInfo.html#a2ff38a7202adb5f8d3b8a3ede61ca4ec" title="A MinidumpRVAList pointing to MinidumpUTF8String objects. The module controls the data that appears h...">list_annotations</a> or <a class="el" href="structcrashpad_1_1MinidumpModuleCrashpadInfo.html#ac200fe528c804f9047d990470b840dc9" title="A MinidumpAnnotationList object containing the annotation objects stored within the module....">annotation_objects</a>.</p>
<p>This field is present when <a class="el" href="structcrashpad_1_1MinidumpModuleCrashpadInfo.html#ace07d8872cdaa53ca20a04513deb56c3" title="The structure’s version number.">version</a> is at least <code>1</code>. </p>
</div>
</div>
<a id="ace07d8872cdaa53ca20a04513deb56c3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ace07d8872cdaa53ca20a04513deb56c3">&#9670;&nbsp;</a></span>version</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t crashpad::MinidumpModuleCrashpadInfo::version</td>
</tr>
</table>
</div><div class="memdoc">
<p>The structure’s version number. </p>
<p>Readers can use this field to determine which other fields in the structure are valid. Upon encountering a value greater than <a class="el" href="structcrashpad_1_1MinidumpModuleCrashpadInfo.html#a47ff487dfe930f561edda132627bd7c0" title="The structure’s currently-defined version number.">kVersion</a>, a reader should assume that the structure’s layout is compatible with the structure defined as having value <a class="el" href="structcrashpad_1_1MinidumpModuleCrashpadInfo.html#a47ff487dfe930f561edda132627bd7c0" title="The structure’s currently-defined version number.">kVersion</a>.</p>
<p>Writers may produce values less than <a class="el" href="structcrashpad_1_1MinidumpModuleCrashpadInfo.html#a47ff487dfe930f561edda132627bd7c0" title="The structure’s currently-defined version number.">kVersion</a> in this field if there is no need for any fields present in later versions. </p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following files:<ul>
<li>minidump/minidump_extensions.h</li>
<li>minidump/minidump_extensions.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>