| <!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::CrashpadInfoClientOptions 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_1CrashpadInfoClientOptions.html">CrashpadInfoClientOptions</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-static-methods">Static Public Member Functions</a> | |
| <a href="#pub-attribs">Public Attributes</a> | |
| <a href="structcrashpad_1_1CrashpadInfoClientOptions-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">crashpad::CrashpadInfoClientOptions Struct Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Options represented in a client’s <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. |
| <a href="structcrashpad_1_1CrashpadInfoClientOptions.html#details">More...</a></p> |
| |
| <p><code>#include "snapshot/crashpad_info_client_options.h"</code></p> |
| <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:a51b98eb48cf16507c075ba96611e30c2"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="namespacecrashpad.html#a3b405c19a5787fabcfba96001d49f292">TriState</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structcrashpad_1_1CrashpadInfoClientOptions.html#a51b98eb48cf16507c075ba96611e30c2">TriStateFromCrashpadInfo</a> (uint8_t crashpad_info_tri_state)</td></tr> |
| <tr class="memdesc:a51b98eb48cf16507c075ba96611e30c2"><td class="mdescLeft"> </td><td class="mdescRight">Converts <code>uint8_t</code> value to a TriState value. <a href="#a51b98eb48cf16507c075ba96611e30c2">More...</a><br /></td></tr> |
| <tr class="separator:a51b98eb48cf16507c075ba96611e30c2"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><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:a1bb1434593a93634c9f352145e002d41"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacecrashpad.html#a3b405c19a5787fabcfba96001d49f292">TriState</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structcrashpad_1_1CrashpadInfoClientOptions.html#a1bb1434593a93634c9f352145e002d41">crashpad_handler_behavior</a></td></tr> |
| <tr class="separator:a1bb1434593a93634c9f352145e002d41"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a7813481d6849f01b15a1d8ba0e984587"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacecrashpad.html#a3b405c19a5787fabcfba96001d49f292">TriState</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structcrashpad_1_1CrashpadInfoClientOptions.html#a7813481d6849f01b15a1d8ba0e984587">system_crash_reporter_forwarding</a></td></tr> |
| <tr class="separator:a7813481d6849f01b15a1d8ba0e984587"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a1b6b914b622f9cb6f69f2b8d92c57138"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacecrashpad.html#a3b405c19a5787fabcfba96001d49f292">TriState</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structcrashpad_1_1CrashpadInfoClientOptions.html#a1b6b914b622f9cb6f69f2b8d92c57138">gather_indirectly_referenced_memory</a></td></tr> |
| <tr class="separator:a1b6b914b622f9cb6f69f2b8d92c57138"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aa9aba9adef6705671e909733b29775b5"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structcrashpad_1_1CrashpadInfoClientOptions.html#aa9aba9adef6705671e909733b29775b5">indirectly_referenced_memory_cap</a></td></tr> |
| <tr class="separator:aa9aba9adef6705671e909733b29775b5"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Options represented in a client’s <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. </p> |
| <p>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> structure is not suitable to expose client options in a generic way at the snapshot level. This structure duplicates option-related fields from the client structure for general use within the snapshot layer and by users of this layer.</p> |
| <p>For objects of this type corresponding to a module, option values are taken from the module’s <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 directly. If the module has no such structure, option values appear unset.</p> |
| <p>For objects of this type corresponding to an entire process, option values are taken from 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> structures of modules within the process. The first module found with a set value (enabled or disabled) will provide an option value for the process. Different modules may provide values for different options. If no module in the process sets a value for an option, the option will appear unset for the process. If no module in the process 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, all option values will appear unset. </p> |
| </div><h2 class="groupheader">Member Function Documentation</h2> |
| <a id="a51b98eb48cf16507c075ba96611e30c2"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a51b98eb48cf16507c075ba96611e30c2">◆ </a></span>TriStateFromCrashpadInfo()</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#a3b405c19a5787fabcfba96001d49f292">TriState</a> crashpad::CrashpadInfoClientOptions::TriStateFromCrashpadInfo </td> |
| <td>(</td> |
| <td class="paramtype">uint8_t </td> |
| <td class="paramname"><em>crashpad_info_tri_state</em></td><td>)</td> |
| <td></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>Converts <code>uint8_t</code> value to a TriState value. </p> |
| <p>The process_types layer exposes TriState as a <code>uint8_t</code> rather than an enum type. This function converts these values into the equivalent enum values used in the snapshot layer.</p> |
| <dl class="section return"><dt>Returns</dt><dd>The TriState equivalent of <em>crashpad_info_tri_state</em>, if it is a valid TriState value. Otherwise, logs a warning and returns <a class="el" href="namespacecrashpad.html#a3b405c19a5787fabcfba96001d49f292ac69d34d47bfd5244204004878441d53f" title="The value has not explicitly been set. ">TriState::kUnset</a>. </dd></dl> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Data Documentation</h2> |
| <a id="a1bb1434593a93634c9f352145e002d41"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a1bb1434593a93634c9f352145e002d41">◆ </a></span>crashpad_handler_behavior</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="namespacecrashpad.html#a3b405c19a5787fabcfba96001d49f292">TriState</a> crashpad::CrashpadInfoClientOptions::crashpad_handler_behavior</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <dl class="section see"><dt>See also</dt><dd><a class="el" href="structcrashpad_1_1CrashpadInfo.html#affa1b598fdd468a56d5cd1c7241ca85d" title="Enables or disables Crashpad handler processing. ">CrashpadInfo::set_crashpad_handler_behavior()</a> </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a1b6b914b622f9cb6f69f2b8d92c57138"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a1b6b914b622f9cb6f69f2b8d92c57138">◆ </a></span>gather_indirectly_referenced_memory</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="namespacecrashpad.html#a3b405c19a5787fabcfba96001d49f292">TriState</a> crashpad::CrashpadInfoClientOptions::gather_indirectly_referenced_memory</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <dl class="section see"><dt>See also</dt><dd><a class="el" href="structcrashpad_1_1CrashpadInfo.html#a2e0a2a0a8a21007a3c7da69795c4eed8" title="Enables or disables Crashpad capturing indirectly referenced memory in the minidump. ">CrashpadInfo::set_gather_indirectly_referenced_memory()</a> </dd></dl> |
| |
| </div> |
| </div> |
| <a id="aa9aba9adef6705671e909733b29775b5"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aa9aba9adef6705671e909733b29775b5">◆ </a></span>indirectly_referenced_memory_cap</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">uint32_t crashpad::CrashpadInfoClientOptions::indirectly_referenced_memory_cap</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <dl class="section see"><dt>See also</dt><dd><a class="el" href="structcrashpad_1_1CrashpadInfo.html#a2e0a2a0a8a21007a3c7da69795c4eed8" title="Enables or disables Crashpad capturing indirectly referenced memory in the minidump. ">CrashpadInfo::set_gather_indirectly_referenced_memory()</a> </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a7813481d6849f01b15a1d8ba0e984587"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a7813481d6849f01b15a1d8ba0e984587">◆ </a></span>system_crash_reporter_forwarding</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="namespacecrashpad.html#a3b405c19a5787fabcfba96001d49f292">TriState</a> crashpad::CrashpadInfoClientOptions::system_crash_reporter_forwarding</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <dl class="section see"><dt>See also</dt><dd><a class="el" href="structcrashpad_1_1CrashpadInfo.html#af055c05be2e7025d0931585bd6a9b755" title="Enables or disables Crashpad forwarding of exceptions to the system’s crash reporter. ">CrashpadInfo::set_system_crash_reporter_forwarding()</a> </dd></dl> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this struct was generated from the following files:<ul> |
| <li>snapshot/crashpad_info_client_options.h</li> |
| <li>snapshot/crashpad_info_client_options.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> |