blob: 0f92874b21c4aec50a747e36c7e48b19817d5219 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Crashpad: crashpad::MinidumpCrashpadInfo 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.14 -->
<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_1MinidumpCrashpadInfo.html">MinidumpCrashpadInfo</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_1MinidumpCrashpadInfo-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">crashpad::MinidumpCrashpadInfo Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Additional Crashpad-specific information carried within a minidump file.
<a href="structcrashpad_1_1MinidumpCrashpadInfo.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:a481042efad46164dc43d9c824df9e6cf"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcrashpad_1_1MinidumpCrashpadInfo.html#a481042efad46164dc43d9c824df9e6cf">version</a></td></tr>
<tr class="memdesc:a481042efad46164dc43d9c824df9e6cf"><td class="mdescLeft">&#160;</td><td class="mdescRight">The structure’s version number. <a href="#a481042efad46164dc43d9c824df9e6cf">More...</a><br /></td></tr>
<tr class="separator:a481042efad46164dc43d9c824df9e6cf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aafc76da0c1b16c5de7ef2c76800508df"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structcrashpad_1_1UUID.html">UUID</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcrashpad_1_1MinidumpCrashpadInfo.html#aafc76da0c1b16c5de7ef2c76800508df">report_id</a></td></tr>
<tr class="memdesc:aafc76da0c1b16c5de7ef2c76800508df"><td class="mdescLeft">&#160;</td><td class="mdescRight">A UUID identifying an individual crash report. <a href="#aafc76da0c1b16c5de7ef2c76800508df">More...</a><br /></td></tr>
<tr class="separator:aafc76da0c1b16c5de7ef2c76800508df"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad83ed0b5dd10f4ddaf138caf96861b97"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structcrashpad_1_1UUID.html">UUID</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcrashpad_1_1MinidumpCrashpadInfo.html#ad83ed0b5dd10f4ddaf138caf96861b97">client_id</a></td></tr>
<tr class="memdesc:ad83ed0b5dd10f4ddaf138caf96861b97"><td class="mdescLeft">&#160;</td><td class="mdescRight">A UUID identifying the client that crashed. <a href="#ad83ed0b5dd10f4ddaf138caf96861b97">More...</a><br /></td></tr>
<tr class="separator:ad83ed0b5dd10f4ddaf138caf96861b97"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8a6300d72ebb8dab13ca50947e37348f"><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_1MinidumpCrashpadInfo.html#a8a6300d72ebb8dab13ca50947e37348f">simple_annotations</a></td></tr>
<tr class="memdesc:a8a6300d72ebb8dab13ca50947e37348f"><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. <a href="#a8a6300d72ebb8dab13ca50947e37348f">More...</a><br /></td></tr>
<tr class="separator:a8a6300d72ebb8dab13ca50947e37348f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a343f824f5f16c241eb8ff11b71cf39ec"><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_1MinidumpCrashpadInfo.html#a343f824f5f16c241eb8ff11b71cf39ec">module_list</a></td></tr>
<tr class="memdesc:a343f824f5f16c241eb8ff11b71cf39ec"><td class="mdescLeft">&#160;</td><td class="mdescRight">A pointer to a <a class="el" href="structcrashpad_1_1MinidumpModuleCrashpadInfoList.html" title="Additional Crashpad-specific information about modules carried within a minidump file. ">MinidumpModuleCrashpadInfoList</a> structure. <a href="#a343f824f5f16c241eb8ff11b71cf39ec">More...</a><br /></td></tr>
<tr class="separator:a343f824f5f16c241eb8ff11b71cf39ec"><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:ac7d7756efc10878a8f76a903c4d6d8d4"><td class="memItemLeft" align="right" valign="top">static constexpr uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcrashpad_1_1MinidumpCrashpadInfo.html#ac7d7756efc10878a8f76a903c4d6d8d4">kVersion</a> = 1</td></tr>
<tr class="memdesc:ac7d7756efc10878a8f76a903c4d6d8d4"><td class="mdescLeft">&#160;</td><td class="mdescRight">The structure’s currently-defined version number. <a href="#ac7d7756efc10878a8f76a903c4d6d8d4">More...</a><br /></td></tr>
<tr class="separator:ac7d7756efc10878a8f76a903c4d6d8d4"><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 carried within a minidump file. </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_1MinidumpCrashpadInfo.html#ac7d7756efc10878a8f76a903c4d6d8d4" title="The structure’s currently-defined version number. ">kVersion</a> and document each field’s validity based on <a class="el" href="structcrashpad_1_1MinidumpCrashpadInfo.html#a481042efad46164dc43d9c824df9e6cf" 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>
</div><h2 class="groupheader">Member Data Documentation</h2>
<a id="ad83ed0b5dd10f4ddaf138caf96861b97"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad83ed0b5dd10f4ddaf138caf96861b97">&#9670;&nbsp;</a></span>client_id</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structcrashpad_1_1UUID.html">UUID</a> crashpad::MinidumpCrashpadInfo::client_id</td>
</tr>
</table>
</div><div class="memdoc">
<p>A UUID identifying the client that crashed. </p>
<p>Client identification is within the scope of the application, but it is expected that the identifier will be unique for an instance of Crashpad monitoring an application or set of applications for a user. The identifier shall remain stable over time.</p>
<p>If no identifier is available, this field will contain zeroes.</p>
<p>This field is present when <a class="el" href="structcrashpad_1_1MinidumpCrashpadInfo.html#a481042efad46164dc43d9c824df9e6cf" title="The structure’s version number. ">version</a> is at least <code>1</code>. </p>
</div>
</div>
<a id="ac7d7756efc10878a8f76a903c4d6d8d4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac7d7756efc10878a8f76a903c4d6d8d4">&#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::MinidumpCrashpadInfo::kVersion = 1</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</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_1MinidumpCrashpadInfo.html#a481042efad46164dc43d9c824df9e6cf" title="The structure’s version number. ">version</a> </dd></dl>
</div>
</div>
<a id="a343f824f5f16c241eb8ff11b71cf39ec"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a343f824f5f16c241eb8ff11b71cf39ec">&#9670;&nbsp;</a></span>module_list</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::MinidumpCrashpadInfo::module_list</td>
</tr>
</table>
</div><div class="memdoc">
<p>A pointer to a <a class="el" href="structcrashpad_1_1MinidumpModuleCrashpadInfoList.html" title="Additional Crashpad-specific information about modules carried within a minidump file. ">MinidumpModuleCrashpadInfoList</a> structure. </p>
<p>This field is present when <a class="el" href="structcrashpad_1_1MinidumpCrashpadInfo.html#a481042efad46164dc43d9c824df9e6cf" title="The structure’s version number. ">version</a> is at least <code>1</code>. </p>
</div>
</div>
<a id="aafc76da0c1b16c5de7ef2c76800508df"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aafc76da0c1b16c5de7ef2c76800508df">&#9670;&nbsp;</a></span>report_id</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structcrashpad_1_1UUID.html">UUID</a> crashpad::MinidumpCrashpadInfo::report_id</td>
</tr>
</table>
</div><div class="memdoc">
<p>A UUID identifying an individual crash report. </p>
<p>This provides a stable identifier for a crash even as the report is converted to different formats, provided that all formats support storing a crash report ID.</p>
<p>If no identifier is available, this field will contain zeroes.</p>
<p>This field is present when <a class="el" href="structcrashpad_1_1MinidumpCrashpadInfo.html#a481042efad46164dc43d9c824df9e6cf" title="The structure’s version number. ">version</a> is at least <code>1</code>. </p>
</div>
</div>
<a id="a8a6300d72ebb8dab13ca50947e37348f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8a6300d72ebb8dab13ca50947e37348f">&#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::MinidumpCrashpadInfo::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. </p>
<p>These key-value pairs correspond to <a class="el" href="classcrashpad_1_1ProcessSnapshot.html#a7f39b29ec055fb4235e5156d55e066cb" title="Returns key-value string annotations recorded for the process, system, or snapshot producer...">ProcessSnapshot::AnnotationsSimpleMap()</a>.</p>
<p>This field is present when <a class="el" href="structcrashpad_1_1MinidumpCrashpadInfo.html#a481042efad46164dc43d9c824df9e6cf" title="The structure’s version number. ">version</a> is at least <code>1</code>. </p>
</div>
</div>
<a id="a481042efad46164dc43d9c824df9e6cf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a481042efad46164dc43d9c824df9e6cf">&#9670;&nbsp;</a></span>version</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t crashpad::MinidumpCrashpadInfo::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_1MinidumpCrashpadInfo.html#ac7d7756efc10878a8f76a903c4d6d8d4" 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_1MinidumpCrashpadInfo.html#ac7d7756efc10878a8f76a903c4d6d8d4" title="The structure’s currently-defined version number. ">kVersion</a>.</p>
<p>Writers may produce values less than <a class="el" href="structcrashpad_1_1MinidumpCrashpadInfo.html#ac7d7756efc10878a8f76a903c4d6d8d4" 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.14
</small></address>
</body>
</html>