| <!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::CrashReportDatabase::NewReport Class 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&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="classcrashpad_1_1CrashReportDatabase.html">CrashReportDatabase</a></li><li class="navelem"><a class="el" href="classcrashpad_1_1CrashReportDatabase_1_1NewReport.html">NewReport</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="#friends">Friends</a> | |
| <a href="classcrashpad_1_1CrashReportDatabase_1_1NewReport-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">crashpad::CrashReportDatabase::NewReport Class Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>A crash report that is in the process of being written. |
| <a href="classcrashpad_1_1CrashReportDatabase_1_1NewReport.html#details">More...</a></p> |
| |
| <p><code>#include "client/crash_report_database.h"</code></p> |
| <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:af095c8267d863ad746448fd9dea806a0"><td class="memItemLeft" align="right" valign="top"><a id="af095c8267d863ad746448fd9dea806a0"></a> |
| <a class="el" href="classcrashpad_1_1FileWriter.html">FileWriter</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1CrashReportDatabase_1_1NewReport.html#af095c8267d863ad746448fd9dea806a0">Writer</a> () const</td></tr> |
| <tr class="memdesc:af095c8267d863ad746448fd9dea806a0"><td class="mdescLeft"> </td><td class="mdescRight">An open <a class="el" href="classcrashpad_1_1FileWriter.html" title="A file writer implementation that wraps traditional system file operations on files accessed through ...">FileWriter</a> with which to write the report. <br /></td></tr> |
| <tr class="separator:af095c8267d863ad746448fd9dea806a0"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a251a6c391ffcf4b4fe6466109fb7aa24"><td class="memItemLeft" align="right" valign="top"><a id="a251a6c391ffcf4b4fe6466109fb7aa24"></a> |
| <a class="el" href="classcrashpad_1_1FileReaderInterface.html">FileReaderInterface</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1CrashReportDatabase_1_1NewReport.html#a251a6c391ffcf4b4fe6466109fb7aa24">Reader</a> ()</td></tr> |
| <tr class="memdesc:a251a6c391ffcf4b4fe6466109fb7aa24"><td class="mdescLeft"> </td><td class="mdescRight">Returns a <a class="el" href="classcrashpad_1_1FileReaderInterface.html" title="An interface to read to files and other file-like objects with semantics matching the underlying plat...">FileReaderInterface</a> to the report, or <code>nullptr</code> with a message logged. <br /></td></tr> |
| <tr class="separator:a251a6c391ffcf4b4fe6466109fb7aa24"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ab07cdbaa56e826dce3403ac4a2f9b418"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="structcrashpad_1_1UUID.html">UUID</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1CrashReportDatabase_1_1NewReport.html#ab07cdbaa56e826dce3403ac4a2f9b418">ReportID</a> () const</td></tr> |
| <tr class="separator:ab07cdbaa56e826dce3403ac4a2f9b418"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a09449d5f327d910cc079ea17c087bd22"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classcrashpad_1_1FileWriter.html">FileWriter</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1CrashReportDatabase_1_1NewReport.html#a09449d5f327d910cc079ea17c087bd22">AddAttachment</a> (const std::string &name)</td></tr> |
| <tr class="memdesc:a09449d5f327d910cc079ea17c087bd22"><td class="mdescLeft"> </td><td class="mdescRight">Adds an attachment to the report. <a href="classcrashpad_1_1CrashReportDatabase_1_1NewReport.html#a09449d5f327d910cc079ea17c087bd22">More...</a><br /></td></tr> |
| <tr class="separator:a09449d5f327d910cc079ea17c087bd22"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a> |
| Friends</h2></td></tr> |
| <tr class="memitem:ab124d91605e5de40c17af73e07db7846"><td class="memItemLeft" align="right" valign="top"><a id="ab124d91605e5de40c17af73e07db7846"></a> |
| class </td><td class="memItemRight" valign="bottom"><b>CrashReportDatabaseGeneric</b></td></tr> |
| <tr class="separator:ab124d91605e5de40c17af73e07db7846"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ab6f1a5884d7972a4e3912f3c0826c71e"><td class="memItemLeft" align="right" valign="top"><a id="ab6f1a5884d7972a4e3912f3c0826c71e"></a> |
| class </td><td class="memItemRight" valign="bottom"><b>CrashReportDatabaseMac</b></td></tr> |
| <tr class="separator:ab6f1a5884d7972a4e3912f3c0826c71e"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ad66b88d20dd3ef27d01c8de082e65579"><td class="memItemLeft" align="right" valign="top"><a id="ad66b88d20dd3ef27d01c8de082e65579"></a> |
| class </td><td class="memItemRight" valign="bottom"><b>CrashReportDatabaseWin</b></td></tr> |
| <tr class="separator:ad66b88d20dd3ef27d01c8de082e65579"><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 crash report that is in the process of being written. </p> |
| <p>An instance of this class should be created via <a class="el" href="classcrashpad_1_1CrashReportDatabase.html#a2e40ddf9bc49998c7cd30eb4035bb23f" title="Creates a record of a new crash report.">PrepareNewCrashReport()</a>. </p> |
| </div><h2 class="groupheader">Member Function Documentation</h2> |
| <a id="a09449d5f327d910cc079ea17c087bd22"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a09449d5f327d910cc079ea17c087bd22">◆ </a></span>AddAttachment()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classcrashpad_1_1FileWriter.html">FileWriter</a> * crashpad::CrashReportDatabase::NewReport::AddAttachment </td> |
| <td>(</td> |
| <td class="paramtype">const std::string & </td> |
| <td class="paramname"><em>name</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Adds an attachment to the report. </p> |
| <dl class="section note"><dt>Note</dt><dd>This function is not yet implemented on macOS or Windows.</dd></dl> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">name</td><td>The key and name for the attachment, which will be included in the http upload. The attachment will not appear in the minidump report. <em>name</em> should only use characters from the set <code>[a-zA-Z0-9._-]</code>. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>A <a class="el" href="classcrashpad_1_1FileWriter.html" title="A file writer implementation that wraps traditional system file operations on files accessed through ...">FileWriter</a> that the caller should use to write the contents of the attachment, or <code>nullptr</code> on failure with an error logged. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="ab07cdbaa56e826dce3403ac4a2f9b418"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ab07cdbaa56e826dce3403ac4a2f9b418">◆ </a></span>ReportID()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">const <a class="el" href="structcrashpad_1_1UUID.html">UUID</a>& crashpad::CrashReportDatabase::NewReport::ReportID </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"> |
| <p>A unique identifier by which this report will always be known to the database. </p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following files:<ul> |
| <li>client/crash_report_database.h</li> |
| <li>client/crash_report_database.cc</li> |
| <li>client/crash_report_database_generic.cc</li> |
| <li>client/crash_report_database_mac.mm</li> |
| <li>client/crash_report_database_win.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.18 |
| </small></address> |
| </body> |
| </html> |
