mirror of
https://github.com/chromium/crashpad.git
synced 2025-03-22 20:03:50 +00:00
236 lines
16 KiB
HTML
236 lines
16 KiB
HTML
<!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.9.1"/>
|
||
<title>Crashpad: crashpad::CrashpadInfo 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>
|
||
<script type="text/javascript">
|
||
$(document).ready(function() { init_search(); });
|
||
</script>
|
||
<link href="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 style="padding-left: 0.5em;">
|
||
<div id="projectname">Crashpad
|
||
</div>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
<!-- end header part -->
|
||
<!-- Generated by Doxygen 1.8.9.1 -->
|
||
<script type="text/javascript">
|
||
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||
</script>
|
||
<div id="navrow1" class="tabs">
|
||
<ul class="tablist">
|
||
<li><a href="index.html"><span>Main Page</span></a></li>
|
||
<li><a href="pages.html"><span>Related Pages</span></a></li>
|
||
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
|
||
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
|
||
<li><a href="files.html"><span>Files</span></a></li>
|
||
<li>
|
||
<div id="MSearchBox" class="MSearchBoxInactive">
|
||
<span class="left">
|
||
<img id="MSearchSelect" src="search/mag_sel.png"
|
||
onmouseover="return searchBox.OnSearchSelectShow()"
|
||
onmouseout="return searchBox.OnSearchSelectHide()"
|
||
alt=""/>
|
||
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
||
onfocus="searchBox.OnSearchFieldFocus(true)"
|
||
onblur="searchBox.OnSearchFieldFocus(false)"
|
||
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
||
</span><span class="right">
|
||
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
||
</span>
|
||
</div>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
<div id="navrow2" class="tabs2">
|
||
<ul class="tablist">
|
||
<li><a href="annotated.html"><span>Class List</span></a></li>
|
||
<li><a href="classes.html"><span>Class Index</span></a></li>
|
||
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
|
||
<li><a href="functions.html"><span>Class Members</span></a></li>
|
||
</ul>
|
||
</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_1CrashpadInfo.html">CrashpadInfo</a></li> </ul>
|
||
</div>
|
||
</div><!-- top -->
|
||
<div class="header">
|
||
<div class="summary">
|
||
<a href="#pub-types">Public Types</a> |
|
||
<a href="#pub-methods">Public Member Functions</a> |
|
||
<a href="#pub-static-methods">Static Public Member Functions</a> |
|
||
<a href="structcrashpad_1_1CrashpadInfo-members.html">List of all members</a> </div>
|
||
<div class="headertitle">
|
||
<div class="title">crashpad::CrashpadInfo Struct Reference</div> </div>
|
||
</div><!--header-->
|
||
<div class="contents">
|
||
|
||
<p>A structure that can be used by a Crashpad-enabled program to provide information to the Crashpad crash handler.
|
||
<a href="structcrashpad_1_1CrashpadInfo.html#details">More...</a></p>
|
||
|
||
<p><code>#include "client/crashpad_info.h"</code></p>
|
||
<table class="memberdecls">
|
||
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
|
||
Public Types</h2></td></tr>
|
||
<tr class="memitem:a9cbd50ce0160938ab7925f3a44ff116b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9cbd50ce0160938ab7925f3a44ff116b"></a>enum  </td><td class="memItemRight" valign="bottom">: uint32_t </td></tr>
|
||
<tr class="separator:a9cbd50ce0160938ab7925f3a44ff116b"><td class="memSeparator" colspan="2"> </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:a36ecf9db10bcc0714d9355c6b47f88df"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="structcrashpad_1_1CrashpadInfo.html#a36ecf9db10bcc0714d9355c6b47f88df">set_simple_annotations</a> (<a class="el" href="namespacecrashpad.html#ac21afdb4f6e3c57ccf3bd34ea8410978">SimpleStringDictionary</a> *simple_annotations)</td></tr>
|
||
<tr class="memdesc:a36ecf9db10bcc0714d9355c6b47f88df"><td class="mdescLeft"> </td><td class="mdescRight">Sets the simple annotations dictionary. <a href="#a36ecf9db10bcc0714d9355c6b47f88df">More...</a><br /></td></tr>
|
||
<tr class="separator:a36ecf9db10bcc0714d9355c6b47f88df"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:affa1b598fdd468a56d5cd1c7241ca85d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="structcrashpad_1_1CrashpadInfo.html#affa1b598fdd468a56d5cd1c7241ca85d">set_crashpad_handler_behavior</a> (<a class="el" href="namespacecrashpad.html#a3b405c19a5787fabcfba96001d49f292">TriState</a> crashpad_handler_behavior)</td></tr>
|
||
<tr class="memdesc:affa1b598fdd468a56d5cd1c7241ca85d"><td class="mdescLeft"> </td><td class="mdescRight">Enables or disables Crashpad handler processing. <a href="#affa1b598fdd468a56d5cd1c7241ca85d">More...</a><br /></td></tr>
|
||
<tr class="separator:affa1b598fdd468a56d5cd1c7241ca85d"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:af055c05be2e7025d0931585bd6a9b755"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="structcrashpad_1_1CrashpadInfo.html#af055c05be2e7025d0931585bd6a9b755">set_system_crash_reporter_forwarding</a> (<a class="el" href="namespacecrashpad.html#a3b405c19a5787fabcfba96001d49f292">TriState</a> system_crash_reporter_forwarding)</td></tr>
|
||
<tr class="memdesc:af055c05be2e7025d0931585bd6a9b755"><td class="mdescLeft"> </td><td class="mdescRight">Enables or disables Crashpad forwarding of exceptions to the system’s crash reporter. <a href="#af055c05be2e7025d0931585bd6a9b755">More...</a><br /></td></tr>
|
||
<tr class="separator:af055c05be2e7025d0931585bd6a9b755"><td class="memSeparator" colspan="2"> </td></tr>
|
||
</table><table class="memberdecls">
|
||
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
|
||
Static Public Member Functions</h2></td></tr>
|
||
<tr class="memitem:a4f8a74e178343694b264f27be26f9898"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4f8a74e178343694b264f27be26f9898"></a>
|
||
static <a class="el" href="structcrashpad_1_1CrashpadInfo.html">CrashpadInfo</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structcrashpad_1_1CrashpadInfo.html#a4f8a74e178343694b264f27be26f9898">GetCrashpadInfo</a> ()</td></tr>
|
||
<tr class="memdesc:a4f8a74e178343694b264f27be26f9898"><td class="mdescLeft"> </td><td class="mdescRight">Returns the global <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> structure. <br /></td></tr>
|
||
<tr class="separator:a4f8a74e178343694b264f27be26f9898"><td class="memSeparator" colspan="2"> </td></tr>
|
||
</table>
|
||
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
||
<div class="textblock"><p>A structure that can be used by a Crashpad-enabled program to provide information to the Crashpad crash handler. </p>
|
||
<p>It is possible for one <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> structure to appear in each loaded code module in a process, but from the perspective of the user of the client interface, there is only one global <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> structure, located in the module that contains the client interface code. </p>
|
||
</div><h2 class="groupheader">Member Function Documentation</h2>
|
||
<a class="anchor" id="affa1b598fdd468a56d5cd1c7241ca85d"></a>
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="mlabels">
|
||
<tr>
|
||
<td class="mlabels-left">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">void crashpad::CrashpadInfo::set_crashpad_handler_behavior </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="namespacecrashpad.html#a3b405c19a5787fabcfba96001d49f292">TriState</a> </td>
|
||
<td class="paramname"><em>crashpad_handler_behavior</em></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
<td class="mlabels-right">
|
||
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Enables or disables Crashpad handler processing. </p>
|
||
<p>When handling an exception, the Crashpad handler will scan all modules in a process. The first one that has 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> structure populated with a value other than <a class="el" href="namespacecrashpad.html#a3b405c19a5787fabcfba96001d49f292ac69d34d47bfd5244204004878441d53f" title="The value has not explicitly been set. ">kUnset</a> for this field will dictate whether the handler is functional or not. If all modules with 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> structure specify <a class="el" href="namespacecrashpad.html#a3b405c19a5787fabcfba96001d49f292ac69d34d47bfd5244204004878441d53f" title="The value has not explicitly been set. ">kUnset</a>, the handler will be enabled. If disabled, the Crashpad handler will still run and receive exceptions, but will not take any action on an exception on its own behalf, except for the action necessary to determine that it has been disabled.</p>
|
||
<p>The Crashpad handler should not normally be disabled. More commonly, it is appropraite to disable crash report upload by calling <a class="el" href="classcrashpad_1_1Settings.html#a1af15625bc137e0a67f6f9fcf016382b" title="Sets the user’s preference for submitting crash reports to a collection server. ">Settings::SetUploadsEnabled()</a>. </p>
|
||
|
||
</div>
|
||
</div>
|
||
<a class="anchor" id="a36ecf9db10bcc0714d9355c6b47f88df"></a>
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="mlabels">
|
||
<tr>
|
||
<td class="mlabels-left">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">void crashpad::CrashpadInfo::set_simple_annotations </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="namespacecrashpad.html#ac21afdb4f6e3c57ccf3bd34ea8410978">SimpleStringDictionary</a> * </td>
|
||
<td class="paramname"><em>simple_annotations</em></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
<td class="mlabels-right">
|
||
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Sets the simple annotations dictionary. </p>
|
||
<p>Simple annotations set on 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> structure are interpreted by Crashpad as module-level annotations.</p>
|
||
<p>Annotations may exist in <em>simple_annotations</em> at the time that this method is called, or they may be added, removed, or modified in <em>simple_annotations</em> after this method is called.</p>
|
||
<dl class="params"><dt>Parameters</dt><dd>
|
||
<table class="params">
|
||
<tr><td class="paramdir">[in]</td><td class="paramname">simple_annotations</td><td>A dictionary that maps string keys to string values. The <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> object does not take ownership of the SimpleStringDictionary object. It is the caller’s responsibility to ensure that this pointer remains valid while it is in effect for 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> object. </td></tr>
|
||
</table>
|
||
</dd>
|
||
</dl>
|
||
|
||
</div>
|
||
</div>
|
||
<a class="anchor" id="af055c05be2e7025d0931585bd6a9b755"></a>
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="mlabels">
|
||
<tr>
|
||
<td class="mlabels-left">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">void crashpad::CrashpadInfo::set_system_crash_reporter_forwarding </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="namespacecrashpad.html#a3b405c19a5787fabcfba96001d49f292">TriState</a> </td>
|
||
<td class="paramname"><em>system_crash_reporter_forwarding</em></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
<td class="mlabels-right">
|
||
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Enables or disables Crashpad forwarding of exceptions to the system’s crash reporter. </p>
|
||
<p>When handling an exception, the Crashpad handler will scan all modules in a process. The first one that has 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> structure populated with a value other than <a class="el" href="namespacecrashpad.html#a3b405c19a5787fabcfba96001d49f292ac69d34d47bfd5244204004878441d53f" title="The value has not explicitly been set. ">kUnset</a> for this field will dictate whether the exception is forwarded to the system’s crash reporter. If all modules with 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> structure specify <a class="el" href="namespacecrashpad.html#a3b405c19a5787fabcfba96001d49f292ac69d34d47bfd5244204004878441d53f" title="The value has not explicitly been set. ">kUnset</a>, forwarding will be enabled. Unless disabled, forwarding may still occur if the Crashpad handler is disabled by SetCrashpadHandlerState(). Even when forwarding is enabled, the Crashpad handler may choose not to forward all exceptions to the system’s crash reporter in cases where it has reason to believe that the system’s crash reporter would not normally have handled the exception in Crashpad’s absence. </p>
|
||
|
||
</div>
|
||
</div>
|
||
<hr/>The documentation for this struct was generated from the following files:<ul>
|
||
<li>client/crashpad_info.h</li>
|
||
<li>client/crashpad_info.cc</li>
|
||
</ul>
|
||
</div><!-- contents -->
|
||
<!-- start footer part -->
|
||
<hr class="footer"/><address class="footer"><small>
|
||
Generated by  <a href="http://www.doxygen.org/index.html">
|
||
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
||
</a> 1.8.9.1
|
||
</small></address>
|
||
</body>
|
||
</html>
|