| <!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::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> |
| <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&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&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_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:a39738c027c7fcddac4bfc5d94f40dbcc"><td class="memItemLeft" align="right" valign="top"><a id="a39738c027c7fcddac4bfc5d94f40dbcc"></a>enum  </td><td class="memItemRight" valign="bottom">: uint32_t </td></tr> |
| <tr class="separator:a39738c027c7fcddac4bfc5d94f40dbcc"><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:af3564710ea74bf027653dc855018dd9f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="structcrashpad_1_1CrashpadInfo.html#af3564710ea74bf027653dc855018dd9f">set_extra_memory_ranges</a> (<a class="el" href="namespacecrashpad.html#a3843475bf1f7956af4153e33bd1bd298">SimpleAddressRangeBag</a> *address_range_bag)</td></tr> |
| <tr class="memdesc:af3564710ea74bf027653dc855018dd9f"><td class="mdescLeft"> </td><td class="mdescRight">Sets the bag of extra memory ranges to be included in the snapshot. <a href="#af3564710ea74bf027653dc855018dd9f">More...</a><br /></td></tr> |
| <tr class="separator:af3564710ea74bf027653dc855018dd9f"><td class="memSeparator" colspan="2"> </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> *<a class="el" href="structcrashpad_1_1CrashpadInfo.html#a67acf0c4ef8a78a97e6e602139149df2">simple_annotations</a>)</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:a67acf0c4ef8a78a97e6e602139149df2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacecrashpad.html#ac21afdb4f6e3c57ccf3bd34ea8410978">SimpleStringDictionary</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structcrashpad_1_1CrashpadInfo.html#a67acf0c4ef8a78a97e6e602139149df2">simple_annotations</a> () const</td></tr> |
| <tr class="separator:a67acf0c4ef8a78a97e6e602139149df2"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a8aac19cacb47f0a87b395d9fa4a233de"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="structcrashpad_1_1CrashpadInfo.html#a8aac19cacb47f0a87b395d9fa4a233de">set_annotations_list</a> (<a class="el" href="classcrashpad_1_1AnnotationList.html">AnnotationList</a> *list)</td></tr> |
| <tr class="memdesc:a8aac19cacb47f0a87b395d9fa4a233de"><td class="mdescLeft"> </td><td class="mdescRight">Sets the annotations list. <a href="#a8aac19cacb47f0a87b395d9fa4a233de">More...</a><br /></td></tr> |
| <tr class="separator:a8aac19cacb47f0a87b395d9fa4a233de"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aa1e342db8ad68e829ce945ceeabb562c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classcrashpad_1_1AnnotationList.html">AnnotationList</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structcrashpad_1_1CrashpadInfo.html#aa1e342db8ad68e829ce945ceeabb562c">annotations_list</a> () const</td></tr> |
| <tr class="separator:aa1e342db8ad68e829ce945ceeabb562c"><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> |
| <tr class="memitem:a2e0a2a0a8a21007a3c7da69795c4eed8"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="structcrashpad_1_1CrashpadInfo.html#a2e0a2a0a8a21007a3c7da69795c4eed8">set_gather_indirectly_referenced_memory</a> (<a class="el" href="namespacecrashpad.html#a3b405c19a5787fabcfba96001d49f292">TriState</a> gather_indirectly_referenced_memory, uint32_t limit)</td></tr> |
| <tr class="memdesc:a2e0a2a0a8a21007a3c7da69795c4eed8"><td class="mdescLeft"> </td><td class="mdescRight">Enables or disables Crashpad capturing indirectly referenced memory in the minidump. <a href="#a2e0a2a0a8a21007a3c7da69795c4eed8">More...</a><br /></td></tr> |
| <tr class="separator:a2e0a2a0a8a21007a3c7da69795c4eed8"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a5f6213582b3b4cc22ca46f058343db8e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="structcrashpad_1_1CrashpadInfo.html#a5f6213582b3b4cc22ca46f058343db8e">AddUserDataMinidumpStream</a> (uint32_t stream_type, const void *data, size_t size)</td></tr> |
| <tr class="memdesc:a5f6213582b3b4cc22ca46f058343db8e"><td class="mdescLeft"> </td><td class="mdescRight">Adds a custom stream to the minidump. <a href="#a5f6213582b3b4cc22ca46f058343db8e">More...</a><br /></td></tr> |
| <tr class="separator:a5f6213582b3b4cc22ca46f058343db8e"><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 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 id="a5f6213582b3b4cc22ca46f058343db8e"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a5f6213582b3b4cc22ca46f058343db8e">◆ </a></span>AddUserDataMinidumpStream()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void crashpad::CrashpadInfo::AddUserDataMinidumpStream </td> |
| <td>(</td> |
| <td class="paramtype">uint32_t </td> |
| <td class="paramname"><em>stream_type</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const void * </td> |
| <td class="paramname"><em>data</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">size_t </td> |
| <td class="paramname"><em>size</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Adds a custom stream to the minidump. </p> |
| <p>The memory block referenced by <em>data</em> and <em>size</em> will added to the minidump as separate stream with type <em>stream_type</em>. The memory referred to by <em>data</em> and <em>size</em> is owned by the caller and must remain valid while it is in effect for 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.</p> |
| <p>Note that streams will appear in the minidump in the reverse order to which they are added.</p> |
| <p>TODO(scottmg) This is currently only supported on Windows.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">stream_type</td><td>The stream type identifier to use. This should be normally be larger than <code>MINIDUMP_STREAM_TYPE::LastReservedStream</code> which is <code>0xffff</code>. </td></tr> |
| <tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>The base pointer of the stream data. </td></tr> |
| <tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>The size of the stream data. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="aa1e342db8ad68e829ce945ceeabb562c"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aa1e342db8ad68e829ce945ceeabb562c">◆ </a></span>annotations_list()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classcrashpad_1_1AnnotationList.html">AnnotationList</a>* crashpad::CrashpadInfo::annotations_list </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <dl class="section return"><dt>Returns</dt><dd>The annotations list.</dd></dl> |
| <dl class="section see"><dt>See also</dt><dd><a class="el" href="structcrashpad_1_1CrashpadInfo.html#a8aac19cacb47f0a87b395d9fa4a233de" title="Sets the annotations list. ">set_annotations_list()</a> </dd> |
| <dd> |
| <a class="el" href="classcrashpad_1_1AnnotationList.html#a664f120cd933b02f71332eba369bb644" title="Returns the instance of the list that has been registered on the CrashapdInfo structure. ">AnnotationList::Get()</a> </dd> |
| <dd> |
| <a class="el" href="classcrashpad_1_1AnnotationList.html#ac3f6faf1ddf517756af29eca69af458c" title="Returns the instace of the list, creating and registering it if one is not already set on the Crashap...">AnnotationList::Register()</a> </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a8aac19cacb47f0a87b395d9fa4a233de"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a8aac19cacb47f0a87b395d9fa4a233de">◆ </a></span>set_annotations_list()</h2> |
| |
| <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_annotations_list </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="classcrashpad_1_1AnnotationList.html">AnnotationList</a> * </td> |
| <td class="paramname"><em>list</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 annotations list. </p> |
| <p>Unlike the <em>simple_annotations</em> structure, the <em>annotations</em> can typed data and it is not limited to a dictionary form. Annotations are interpreted by Crashpad as module-level annotations.</p> |
| <p>Annotations may exist in <em>list</em> at the time that this method is called, or they may be added, removed, or modified in <em>list</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">list</td><td>A list of set <a class="el" href="classcrashpad_1_1Annotation.html" title="Base class for an annotation, which records a name-value pair of arbitrary data when set...">Annotation</a> objects that maintain arbitrary, typed key-value state. 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 AnnotationsList 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> |
| <dl class="section see"><dt>See also</dt><dd><a class="el" href="structcrashpad_1_1CrashpadInfo.html#aa1e342db8ad68e829ce945ceeabb562c">annotations_list()</a> </dd> |
| <dd> |
| <a class="el" href="classcrashpad_1_1AnnotationList.html#ac3f6faf1ddf517756af29eca69af458c" title="Returns the instace of the list, creating and registering it if one is not already set on the Crashap...">AnnotationList::Register()</a> </dd></dl> |
| |
| </div> |
| </div> |
| <a id="affa1b598fdd468a56d5cd1c7241ca85d"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#affa1b598fdd468a56d5cd1c7241ca85d">◆ </a></span>set_crashpad_handler_behavior()</h2> |
| |
| <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 appropriate 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 id="af3564710ea74bf027653dc855018dd9f"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#af3564710ea74bf027653dc855018dd9f">◆ </a></span>set_extra_memory_ranges()</h2> |
| |
| <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_extra_memory_ranges </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="namespacecrashpad.html#a3843475bf1f7956af4153e33bd1bd298">SimpleAddressRangeBag</a> * </td> |
| <td class="paramname"><em>address_range_bag</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 bag of extra memory ranges to be included in the snapshot. </p> |
| <p>Extra memory ranges may exist in <em>address_range_bag</em> at the time that this method is called, or they may be added, removed, or modified in <em>address_range_bag</em> after this method is called.</p> |
| <p>TODO(scottmg) This is currently only supported on Windows.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">address_range_bag</td><td>A bag of address ranges. 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 SimpleAddressRangeBag 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 id="a2e0a2a0a8a21007a3c7da69795c4eed8"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a2e0a2a0a8a21007a3c7da69795c4eed8">◆ </a></span>set_gather_indirectly_referenced_memory()</h2> |
| |
| <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_gather_indirectly_referenced_memory </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="namespacecrashpad.html#a3b405c19a5787fabcfba96001d49f292">TriState</a> </td> |
| <td class="paramname"><em>gather_indirectly_referenced_memory</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">uint32_t </td> |
| <td class="paramname"><em>limit</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</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 capturing indirectly referenced memory in the minidump. </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 extra memory is captured.</p> |
| <p>This causes Crashpad to include pages of data referenced by locals or other stack memory. Turning this on can increase the size of the minidump significantly.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">gather_indirectly_referenced_memory</td><td>Whether extra memory should be gathered. </td></tr> |
| <tr><td class="paramdir">[in]</td><td class="paramname">limit</td><td>The amount of memory in bytes after which no more indirectly gathered memory should be captured. This value is only used when <em>gather_indirectly_referenced_memory</em> is <a class="el" href="namespacecrashpad.html#a3b405c19a5787fabcfba96001d49f292ade1ec1870756a80dffbdc4cda53153e0" title="The value has explicitly been set to on, or a behavior has explicitly been enabled. ">TriState::kEnabled</a>. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="a36ecf9db10bcc0714d9355c6b47f88df"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a36ecf9db10bcc0714d9355c6b47f88df">◆ </a></span>set_simple_annotations()</h2> |
| |
| <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> |
| <dl class="section see"><dt>See also</dt><dd><a class="el" href="structcrashpad_1_1CrashpadInfo.html#a67acf0c4ef8a78a97e6e602139149df2">simple_annotations()</a> </dd></dl> |
| |
| </div> |
| </div> |
| <a id="af055c05be2e7025d0931585bd6a9b755"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#af055c05be2e7025d0931585bd6a9b755">◆ </a></span>set_system_crash_reporter_forwarding()</h2> |
| |
| <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> |
| <a id="a67acf0c4ef8a78a97e6e602139149df2"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a67acf0c4ef8a78a97e6e602139149df2">◆ </a></span>simple_annotations()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="namespacecrashpad.html#ac21afdb4f6e3c57ccf3bd34ea8410978">SimpleStringDictionary</a>* crashpad::CrashpadInfo::simple_annotations </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <dl class="section return"><dt>Returns</dt><dd>The simple annotations dictionary.</dd></dl> |
| <dl class="section see"><dt>See also</dt><dd><a class="el" href="structcrashpad_1_1CrashpadInfo.html#a36ecf9db10bcc0714d9355c6b47f88df" title="Sets the simple annotations dictionary. ">set_simple_annotations()</a> </dd></dl> |
| |
| </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.14 |
| </small></address> |
| </body> |
| </html> |
