| <!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::MinidumpAnnotationWriter 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_1MinidumpAnnotationWriter.html">MinidumpAnnotationWriter</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="#pro-methods">Protected Member Functions</a> | |
| <a href="classcrashpad_1_1MinidumpAnnotationWriter-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">crashpad::MinidumpAnnotationWriter Class Reference<span class="mlabels"><span class="mlabel">final</span></span></div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>The writer for a <a class="el" href="structcrashpad_1_1MinidumpAnnotation.html" title="A typed annotation object.">MinidumpAnnotation</a> object in a minidump file. |
| <a href="classcrashpad_1_1MinidumpAnnotationWriter.html#details">More...</a></p> |
| |
| <p><code>#include "minidump/minidump_annotation_writer.h"</code></p> |
| <div class="dynheader"> |
| Inheritance diagram for crashpad::MinidumpAnnotationWriter:</div> |
| <div class="dyncontent"> |
| <div class="center"> |
| <img src="classcrashpad_1_1MinidumpAnnotationWriter.png" usemap="#crashpad::MinidumpAnnotationWriter_map" alt=""/> |
| <map id="crashpad::MinidumpAnnotationWriter_map" name="crashpad::MinidumpAnnotationWriter_map"> |
| <area href="classcrashpad_1_1internal_1_1MinidumpWritable.html" title="The base class for all content that might be written to a minidump file." alt="crashpad::internal::MinidumpWritable" shape="rect" coords="0,0,219,24"/> |
| </map> |
| </div></div> |
| <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:aef8bba7e8cdd58a0a1fb53e657f54aed"><td class="memItemLeft" align="right" valign="top"><a id="aef8bba7e8cdd58a0a1fb53e657f54aed"></a> |
| void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1MinidumpAnnotationWriter.html#aef8bba7e8cdd58a0a1fb53e657f54aed">InitializeFromSnapshot</a> (const <a class="el" href="structcrashpad_1_1AnnotationSnapshot.html">AnnotationSnapshot</a> &snapshot)</td></tr> |
| <tr class="memdesc:aef8bba7e8cdd58a0a1fb53e657f54aed"><td class="mdescLeft"> </td><td class="mdescRight">Initializes the annotation writer with data from an <a class="el" href="structcrashpad_1_1AnnotationSnapshot.html">AnnotationSnapshot</a>. <br /></td></tr> |
| <tr class="separator:aef8bba7e8cdd58a0a1fb53e657f54aed"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aaf8611239d9f7a5f50e8f30a190fbbd3"><td class="memItemLeft" align="right" valign="top"><a id="aaf8611239d9f7a5f50e8f30a190fbbd3"></a> |
| void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1MinidumpAnnotationWriter.html#aaf8611239d9f7a5f50e8f30a190fbbd3">InitializeWithData</a> (const std::string &name, uint16_t type, const std::vector< uint8_t > &data)</td></tr> |
| <tr class="memdesc:aaf8611239d9f7a5f50e8f30a190fbbd3"><td class="mdescLeft"> </td><td class="mdescRight">Initializes the annotation writer with data values. <br /></td></tr> |
| <tr class="separator:aaf8611239d9f7a5f50e8f30a190fbbd3"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a2979bb52242dcdb4e93308244add817f"><td class="memItemLeft" align="right" valign="top"><a id="a2979bb52242dcdb4e93308244add817f"></a> |
| const <a class="el" href="structcrashpad_1_1MinidumpAnnotation.html">MinidumpAnnotation</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1MinidumpAnnotationWriter.html#a2979bb52242dcdb4e93308244add817f">minidump_annotation</a> () const</td></tr> |
| <tr class="memdesc:a2979bb52242dcdb4e93308244add817f"><td class="mdescLeft"> </td><td class="mdescRight">Returns the <a class="el" href="structcrashpad_1_1MinidumpAnnotation.html" title="A typed annotation object.">MinidumpAnnotation</a> referencing this object’s data. <br /></td></tr> |
| <tr class="separator:a2979bb52242dcdb4e93308244add817f"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="inherit_header pub_methods_classcrashpad_1_1internal_1_1MinidumpWritable"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classcrashpad_1_1internal_1_1MinidumpWritable')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classcrashpad_1_1internal_1_1MinidumpWritable.html">crashpad::internal::MinidumpWritable</a></td></tr> |
| <tr class="memitem:a24507e918299cb566c7f15207de83a7f inherit pub_methods_classcrashpad_1_1internal_1_1MinidumpWritable"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1internal_1_1MinidumpWritable.html#a24507e918299cb566c7f15207de83a7f">WriteEverything</a> (<a class="el" href="classcrashpad_1_1FileWriterInterface.html">FileWriterInterface</a> *file_writer)</td></tr> |
| <tr class="memdesc:a24507e918299cb566c7f15207de83a7f inherit pub_methods_classcrashpad_1_1internal_1_1MinidumpWritable"><td class="mdescLeft"> </td><td class="mdescRight">Writes an object and all of its children to a minidump file. <a href="classcrashpad_1_1internal_1_1MinidumpWritable.html#a24507e918299cb566c7f15207de83a7f">More...</a><br /></td></tr> |
| <tr class="separator:a24507e918299cb566c7f15207de83a7f inherit pub_methods_classcrashpad_1_1internal_1_1MinidumpWritable"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a686683d78f099a07e2a1df8e6b567d37 inherit pub_methods_classcrashpad_1_1internal_1_1MinidumpWritable"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1internal_1_1MinidumpWritable.html#a686683d78f099a07e2a1df8e6b567d37">RegisterRVA</a> (<a class="el" href="dbghelp_8h.html#acf465a1a77ecf067a9d946583bc6a3f8">RVA</a> *rva)</td></tr> |
| <tr class="memdesc:a686683d78f099a07e2a1df8e6b567d37 inherit pub_methods_classcrashpad_1_1internal_1_1MinidumpWritable"><td class="mdescLeft"> </td><td class="mdescRight">Registers a file offset pointer as one that should point to the object on which this method is called. <a href="classcrashpad_1_1internal_1_1MinidumpWritable.html#a686683d78f099a07e2a1df8e6b567d37">More...</a><br /></td></tr> |
| <tr class="separator:a686683d78f099a07e2a1df8e6b567d37 inherit pub_methods_classcrashpad_1_1internal_1_1MinidumpWritable"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aed263c64ecb0597696d080e395af6400 inherit pub_methods_classcrashpad_1_1internal_1_1MinidumpWritable"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1internal_1_1MinidumpWritable.html#aed263c64ecb0597696d080e395af6400">RegisterLocationDescriptor</a> (<a class="el" href="structMINIDUMP__LOCATION__DESCRIPTOR.html">MINIDUMP_LOCATION_DESCRIPTOR</a> *location_descriptor)</td></tr> |
| <tr class="memdesc:aed263c64ecb0597696d080e395af6400 inherit pub_methods_classcrashpad_1_1internal_1_1MinidumpWritable"><td class="mdescLeft"> </td><td class="mdescRight">Registers a location descriptor as one that should point to the object on which this method is called. <a href="classcrashpad_1_1internal_1_1MinidumpWritable.html#aed263c64ecb0597696d080e395af6400">More...</a><br /></td></tr> |
| <tr class="separator:aed263c64ecb0597696d080e395af6400 inherit pub_methods_classcrashpad_1_1internal_1_1MinidumpWritable"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a> |
| Protected Member Functions</h2></td></tr> |
| <tr class="memitem:a51ce9cfdaa344db48df5be2973d5bc91"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1MinidumpAnnotationWriter.html#a51ce9cfdaa344db48df5be2973d5bc91">Freeze</a> () override</td></tr> |
| <tr class="memdesc:a51ce9cfdaa344db48df5be2973d5bc91"><td class="mdescLeft"> </td><td class="mdescRight">Transitions the object from <a class="el" href="classcrashpad_1_1internal_1_1MinidumpWritable.html#ac14e05f291f5fa713b5ec82a208fa7c7a18337604dcbdbdb23ed51810f0587665" title="The object’s properties can be modified.">kStateMutable</a> to <a class="el" href="classcrashpad_1_1internal_1_1MinidumpWritable.html#ac14e05f291f5fa713b5ec82a208fa7c7af98547144e0e8d4f878f725ef5c0d611" title="The object is “frozen”.">kStateFrozen</a>. <a href="classcrashpad_1_1MinidumpAnnotationWriter.html#a51ce9cfdaa344db48df5be2973d5bc91">More...</a><br /></td></tr> |
| <tr class="separator:a51ce9cfdaa344db48df5be2973d5bc91"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a48a58c9143c8ccae20fbd49714ad72bc"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1MinidumpAnnotationWriter.html#a48a58c9143c8ccae20fbd49714ad72bc">SizeOfObject</a> () override</td></tr> |
| <tr class="memdesc:a48a58c9143c8ccae20fbd49714ad72bc"><td class="mdescLeft"> </td><td class="mdescRight">Returns the amount of space that this object will consume when written to a minidump file, in bytes, not including any leading or trailing padding necessary to maintain proper alignment. <a href="classcrashpad_1_1MinidumpAnnotationWriter.html#a48a58c9143c8ccae20fbd49714ad72bc">More...</a><br /></td></tr> |
| <tr class="separator:a48a58c9143c8ccae20fbd49714ad72bc"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a8459462f1d5bfba1e54f699ec0e1e781"><td class="memItemLeft" align="right" valign="top">std::vector< <a class="el" href="classcrashpad_1_1internal_1_1MinidumpWritable.html">internal::MinidumpWritable</a> * > </td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1MinidumpAnnotationWriter.html#a8459462f1d5bfba1e54f699ec0e1e781">Children</a> () override</td></tr> |
| <tr class="memdesc:a8459462f1d5bfba1e54f699ec0e1e781"><td class="mdescLeft"> </td><td class="mdescRight">Returns the object’s children. <a href="classcrashpad_1_1MinidumpAnnotationWriter.html#a8459462f1d5bfba1e54f699ec0e1e781">More...</a><br /></td></tr> |
| <tr class="separator:a8459462f1d5bfba1e54f699ec0e1e781"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a6f0a80e45f3b9e652d953cb05fdad777"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1MinidumpAnnotationWriter.html#a6f0a80e45f3b9e652d953cb05fdad777">WriteObject</a> (<a class="el" href="classcrashpad_1_1FileWriterInterface.html">FileWriterInterface</a> *file_writer) override</td></tr> |
| <tr class="memdesc:a6f0a80e45f3b9e652d953cb05fdad777"><td class="mdescLeft"> </td><td class="mdescRight">Writes the object’s content. <a href="classcrashpad_1_1MinidumpAnnotationWriter.html#a6f0a80e45f3b9e652d953cb05fdad777">More...</a><br /></td></tr> |
| <tr class="separator:a6f0a80e45f3b9e652d953cb05fdad777"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="inherit_header pro_methods_classcrashpad_1_1internal_1_1MinidumpWritable"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classcrashpad_1_1internal_1_1MinidumpWritable')"><img src="closed.png" alt="-"/> Protected Member Functions inherited from <a class="el" href="classcrashpad_1_1internal_1_1MinidumpWritable.html">crashpad::internal::MinidumpWritable</a></td></tr> |
| <tr class="memitem:aed27972114564f99cda1e7648aec807a inherit pro_methods_classcrashpad_1_1internal_1_1MinidumpWritable"><td class="memItemLeft" align="right" valign="top"><a id="aed27972114564f99cda1e7648aec807a"></a> |
| <a class="el" href="classcrashpad_1_1internal_1_1MinidumpWritable.html#ac14e05f291f5fa713b5ec82a208fa7c7">State</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1internal_1_1MinidumpWritable.html#aed27972114564f99cda1e7648aec807a">state</a> () const</td></tr> |
| <tr class="memdesc:aed27972114564f99cda1e7648aec807a inherit pro_methods_classcrashpad_1_1internal_1_1MinidumpWritable"><td class="mdescLeft"> </td><td class="mdescRight">The state of the object. <br /></td></tr> |
| <tr class="separator:aed27972114564f99cda1e7648aec807a inherit pro_methods_classcrashpad_1_1internal_1_1MinidumpWritable"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:af4e92c46984eb73dbc1315ff5f4c7a9a inherit pro_methods_classcrashpad_1_1internal_1_1MinidumpWritable"><td class="memItemLeft" align="right" valign="top">virtual size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1internal_1_1MinidumpWritable.html#af4e92c46984eb73dbc1315ff5f4c7a9a">Alignment</a> ()</td></tr> |
| <tr class="memdesc:af4e92c46984eb73dbc1315ff5f4c7a9a inherit pro_methods_classcrashpad_1_1internal_1_1MinidumpWritable"><td class="mdescLeft"> </td><td class="mdescRight">Returns the object’s desired byte-boundary alignment. <a href="classcrashpad_1_1internal_1_1MinidumpWritable.html#af4e92c46984eb73dbc1315ff5f4c7a9a">More...</a><br /></td></tr> |
| <tr class="separator:af4e92c46984eb73dbc1315ff5f4c7a9a inherit pro_methods_classcrashpad_1_1internal_1_1MinidumpWritable"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a389b0ac1986698e80ebbc49198676ac7 inherit pro_methods_classcrashpad_1_1internal_1_1MinidumpWritable"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classcrashpad_1_1internal_1_1MinidumpWritable.html#a009f007265d64a5fb416848480a00ae9">Phase</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1internal_1_1MinidumpWritable.html#a389b0ac1986698e80ebbc49198676ac7">WritePhase</a> ()</td></tr> |
| <tr class="memdesc:a389b0ac1986698e80ebbc49198676ac7 inherit pro_methods_classcrashpad_1_1internal_1_1MinidumpWritable"><td class="mdescLeft"> </td><td class="mdescRight">Returns the object’s desired write phase. <a href="classcrashpad_1_1internal_1_1MinidumpWritable.html#a389b0ac1986698e80ebbc49198676ac7">More...</a><br /></td></tr> |
| <tr class="separator:a389b0ac1986698e80ebbc49198676ac7 inherit pro_methods_classcrashpad_1_1internal_1_1MinidumpWritable"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a712fac2ada227f53c55eb0c4d042f239 inherit pro_methods_classcrashpad_1_1internal_1_1MinidumpWritable"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1internal_1_1MinidumpWritable.html#a712fac2ada227f53c55eb0c4d042f239">WillWriteAtOffset</a> (<a class="el" href="classcrashpad_1_1internal_1_1MinidumpWritable.html#a009f007265d64a5fb416848480a00ae9">Phase</a> phase, <a class="el" href="namespacecrashpad.html#a1e53a1957d9edcba8b406ea632b6daf2">FileOffset</a> *offset, std::vector< <a class="el" href="classcrashpad_1_1internal_1_1MinidumpWritable.html">MinidumpWritable</a> * > *write_sequence)</td></tr> |
| <tr class="memdesc:a712fac2ada227f53c55eb0c4d042f239 inherit pro_methods_classcrashpad_1_1internal_1_1MinidumpWritable"><td class="mdescLeft"> </td><td class="mdescRight">Prepares the object to be written at a known file offset, transitioning it from <a class="el" href="classcrashpad_1_1internal_1_1MinidumpWritable.html#ac14e05f291f5fa713b5ec82a208fa7c7af98547144e0e8d4f878f725ef5c0d611" title="The object is “frozen”.">kStateFrozen</a> to <a class="el" href="classcrashpad_1_1internal_1_1MinidumpWritable.html#ac14e05f291f5fa713b5ec82a208fa7c7a87483823ca30a8257b2a5fbd21805bcd" title="The object is writable.">kStateWritable</a>. <a href="classcrashpad_1_1internal_1_1MinidumpWritable.html#a712fac2ada227f53c55eb0c4d042f239">More...</a><br /></td></tr> |
| <tr class="separator:a712fac2ada227f53c55eb0c4d042f239 inherit pro_methods_classcrashpad_1_1internal_1_1MinidumpWritable"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a2416cb821816b769d95b92e486713ebf inherit pro_methods_classcrashpad_1_1internal_1_1MinidumpWritable"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1internal_1_1MinidumpWritable.html#a2416cb821816b769d95b92e486713ebf">WillWriteAtOffsetImpl</a> (<a class="el" href="namespacecrashpad.html#a1e53a1957d9edcba8b406ea632b6daf2">FileOffset</a> offset)</td></tr> |
| <tr class="memdesc:a2416cb821816b769d95b92e486713ebf inherit pro_methods_classcrashpad_1_1internal_1_1MinidumpWritable"><td class="mdescLeft"> </td><td class="mdescRight">Called once an object’s writable file offset is determined, as it transitions into <a class="el" href="classcrashpad_1_1internal_1_1MinidumpWritable.html#ac14e05f291f5fa713b5ec82a208fa7c7a87483823ca30a8257b2a5fbd21805bcd" title="The object is writable.">kStateWritable</a>. <a href="classcrashpad_1_1internal_1_1MinidumpWritable.html#a2416cb821816b769d95b92e486713ebf">More...</a><br /></td></tr> |
| <tr class="separator:a2416cb821816b769d95b92e486713ebf inherit pro_methods_classcrashpad_1_1internal_1_1MinidumpWritable"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ab82b1e92ae0eced8b8e2efe957411773 inherit pro_methods_classcrashpad_1_1internal_1_1MinidumpWritable"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1internal_1_1MinidumpWritable.html#ab82b1e92ae0eced8b8e2efe957411773">WritePaddingAndObject</a> (<a class="el" href="classcrashpad_1_1FileWriterInterface.html">FileWriterInterface</a> *file_writer)</td></tr> |
| <tr class="memdesc:ab82b1e92ae0eced8b8e2efe957411773 inherit pro_methods_classcrashpad_1_1internal_1_1MinidumpWritable"><td class="mdescLeft"> </td><td class="mdescRight">Writes the object, transitioning it from <a class="el" href="classcrashpad_1_1internal_1_1MinidumpWritable.html#ac14e05f291f5fa713b5ec82a208fa7c7a87483823ca30a8257b2a5fbd21805bcd" title="The object is writable.">kStateWritable</a> to <a class="el" href="classcrashpad_1_1internal_1_1MinidumpWritable.html#ac14e05f291f5fa713b5ec82a208fa7c7af0d794ed29c320fcf35c71f40cc6a510" title="The object has been written to a minidump file.">kStateWritten</a>. <a href="classcrashpad_1_1internal_1_1MinidumpWritable.html#ab82b1e92ae0eced8b8e2efe957411773">More...</a><br /></td></tr> |
| <tr class="separator:ab82b1e92ae0eced8b8e2efe957411773 inherit pro_methods_classcrashpad_1_1internal_1_1MinidumpWritable"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a> |
| Additional Inherited Members</h2></td></tr> |
| <tr class="inherit_header pro_types_classcrashpad_1_1internal_1_1MinidumpWritable"><td colspan="2" onclick="javascript:toggleInherit('pro_types_classcrashpad_1_1internal_1_1MinidumpWritable')"><img src="closed.png" alt="-"/> Protected Types inherited from <a class="el" href="classcrashpad_1_1internal_1_1MinidumpWritable.html">crashpad::internal::MinidumpWritable</a></td></tr> |
| <tr class="memitem:ac14e05f291f5fa713b5ec82a208fa7c7 inherit pro_types_classcrashpad_1_1internal_1_1MinidumpWritable"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1internal_1_1MinidumpWritable.html#ac14e05f291f5fa713b5ec82a208fa7c7">State</a> </td></tr> |
| <tr class="memdesc:ac14e05f291f5fa713b5ec82a208fa7c7"><td class="mdescLeft"> </td><td class="mdescRight">Identifies the state of an object. <a href="classcrashpad_1_1internal_1_1MinidumpWritable.html#ac14e05f291f5fa713b5ec82a208fa7c7">More...</a><br /></td></tr> |
| <tr class="separator:ac14e05f291f5fa713b5ec82a208fa7c7 inherit pro_types_classcrashpad_1_1internal_1_1MinidumpWritable"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a009f007265d64a5fb416848480a00ae9 inherit pro_types_classcrashpad_1_1internal_1_1MinidumpWritable"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1internal_1_1MinidumpWritable.html#a009f007265d64a5fb416848480a00ae9">Phase</a> </td></tr> |
| <tr class="memdesc:a009f007265d64a5fb416848480a00ae9"><td class="mdescLeft"> </td><td class="mdescRight">Identifies the phase during which an object will be written to a minidump file. <a href="classcrashpad_1_1internal_1_1MinidumpWritable.html#a009f007265d64a5fb416848480a00ae9">More...</a><br /></td></tr> |
| <tr class="separator:a009f007265d64a5fb416848480a00ae9 inherit pro_types_classcrashpad_1_1internal_1_1MinidumpWritable"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="inherit_header pro_static_attribs_classcrashpad_1_1internal_1_1MinidumpWritable"><td colspan="2" onclick="javascript:toggleInherit('pro_static_attribs_classcrashpad_1_1internal_1_1MinidumpWritable')"><img src="closed.png" alt="-"/> Static Protected Attributes inherited from <a class="el" href="classcrashpad_1_1internal_1_1MinidumpWritable.html">crashpad::internal::MinidumpWritable</a></td></tr> |
| <tr class="memitem:ac2b31049c4fedaabb24857d82531d6d6 inherit pro_static_attribs_classcrashpad_1_1internal_1_1MinidumpWritable"><td class="memItemLeft" align="right" valign="top"><a id="ac2b31049c4fedaabb24857d82531d6d6"></a> |
| static constexpr size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1internal_1_1MinidumpWritable.html#ac2b31049c4fedaabb24857d82531d6d6">kInvalidSize</a> = std::numeric_limits<size_t>::max()</td></tr> |
| <tr class="memdesc:ac2b31049c4fedaabb24857d82531d6d6 inherit pro_static_attribs_classcrashpad_1_1internal_1_1MinidumpWritable"><td class="mdescLeft"> </td><td class="mdescRight">A size value used to signal failure by methods that return <code>size_t</code>. <br /></td></tr> |
| <tr class="separator:ac2b31049c4fedaabb24857d82531d6d6 inherit pro_static_attribs_classcrashpad_1_1internal_1_1MinidumpWritable"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>The writer for a <a class="el" href="structcrashpad_1_1MinidumpAnnotation.html" title="A typed annotation object.">MinidumpAnnotation</a> object in a minidump file. </p> |
| <p>Because <a class="el" href="structcrashpad_1_1MinidumpAnnotation.html" title="A typed annotation object.">MinidumpAnnotation</a> objects only appear as elements of <a class="el" href="structcrashpad_1_1MinidumpAnnotationList.html" title="A list of annotation objects.">MinidumpAnnotationList</a> objects, this class does not write any data on its own. It makes its <a class="el" href="structcrashpad_1_1MinidumpAnnotation.html" title="A typed annotation object.">MinidumpAnnotation</a> data available to its <a class="el" href="structcrashpad_1_1MinidumpAnnotationList.html" title="A list of annotation objects.">MinidumpAnnotationList</a> parent, which writes it as part of a <a class="el" href="structcrashpad_1_1MinidumpAnnotationList.html" title="A list of annotation objects.">MinidumpAnnotationList</a>. </p> |
| </div><h2 class="groupheader">Member Function Documentation</h2> |
| <a id="a8459462f1d5bfba1e54f699ec0e1e781"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a8459462f1d5bfba1e54f699ec0e1e781">◆ </a></span>Children()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">std::vector< <a class="el" href="classcrashpad_1_1internal_1_1MinidumpWritable.html">internal::MinidumpWritable</a> * > crashpad::MinidumpAnnotationWriter::Children </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Returns the object’s children. </p> |
| <dl class="section note"><dt>Note</dt><dd>Valid in <a class="el" href="classcrashpad_1_1internal_1_1MinidumpWritable.html#ac14e05f291f5fa713b5ec82a208fa7c7af98547144e0e8d4f878f725ef5c0d611" title="The object is “frozen”.">kStateFrozen</a> or any subsequent state. </dd></dl> |
| |
| <p>Reimplemented from <a class="el" href="classcrashpad_1_1internal_1_1MinidumpWritable.html#a32460b7fe2154fbabc3c58bf10dc7861">crashpad::internal::MinidumpWritable</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a51ce9cfdaa344db48df5be2973d5bc91"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a51ce9cfdaa344db48df5be2973d5bc91">◆ </a></span>Freeze()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool crashpad::MinidumpAnnotationWriter::Freeze </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Transitions the object from <a class="el" href="classcrashpad_1_1internal_1_1MinidumpWritable.html#ac14e05f291f5fa713b5ec82a208fa7c7a18337604dcbdbdb23ed51810f0587665" title="The object’s properties can be modified.">kStateMutable</a> to <a class="el" href="classcrashpad_1_1internal_1_1MinidumpWritable.html#ac14e05f291f5fa713b5ec82a208fa7c7af98547144e0e8d4f878f725ef5c0d611" title="The object is “frozen”.">kStateFrozen</a>. </p> |
| <p>The default implementation marks the object as frozen and recursively calls <a class="el" href="classcrashpad_1_1MinidumpAnnotationWriter.html#a51ce9cfdaa344db48df5be2973d5bc91" title="Transitions the object from kStateMutable to kStateFrozen.">Freeze()</a> on all of its children. Subclasses may override this method to perform processing that should only be done once callers have finished populating an object with data. Typically, a subclass implementation would call <a class="el" href="classcrashpad_1_1internal_1_1MinidumpWritable.html#a686683d78f099a07e2a1df8e6b567d37" title="Registers a file offset pointer as one that should point to the object on which this method is called...">RegisterRVA()</a> or <a class="el" href="classcrashpad_1_1internal_1_1MinidumpWritable.html#aed263c64ecb0597696d080e395af6400" title="Registers a location descriptor as one that should point to the object on which this method is called...">RegisterLocationDescriptor()</a> on other objects as appropriate, because at the time <a class="el" href="classcrashpad_1_1MinidumpAnnotationWriter.html#a51ce9cfdaa344db48df5be2973d5bc91" title="Transitions the object from kStateMutable to kStateFrozen.">Freeze()</a> runs, the in-memory locations of RVAs and location descriptors are known and will not change for the remaining duration of an object’s lifetime.</p> |
| <dl class="section return"><dt>Returns</dt><dd><code>true</code> on success. <code>false</code> on failure, with an appropriate message logged. </dd></dl> |
| |
| <p>Reimplemented from <a class="el" href="classcrashpad_1_1internal_1_1MinidumpWritable.html#a773db80946a99c6a3cc29c7d4dd77bd6">crashpad::internal::MinidumpWritable</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a48a58c9143c8ccae20fbd49714ad72bc"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a48a58c9143c8ccae20fbd49714ad72bc">◆ </a></span>SizeOfObject()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">size_t crashpad::MinidumpAnnotationWriter::SizeOfObject </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Returns the amount of space that this object will consume when written to a minidump file, in bytes, not including any leading or trailing padding necessary to maintain proper alignment. </p> |
| <dl class="section note"><dt>Note</dt><dd>Valid in <a class="el" href="classcrashpad_1_1internal_1_1MinidumpWritable.html#ac14e05f291f5fa713b5ec82a208fa7c7af98547144e0e8d4f878f725ef5c0d611" title="The object is “frozen”.">kStateFrozen</a> or any subsequent state. </dd></dl> |
| |
| <p>Implements <a class="el" href="classcrashpad_1_1internal_1_1MinidumpWritable.html#a1483275a3acbdfcecffb7f3c27cd2feb">crashpad::internal::MinidumpWritable</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a6f0a80e45f3b9e652d953cb05fdad777"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a6f0a80e45f3b9e652d953cb05fdad777">◆ </a></span>WriteObject()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool crashpad::MinidumpAnnotationWriter::WriteObject </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="classcrashpad_1_1FileWriterInterface.html">FileWriterInterface</a> * </td> |
| <td class="paramname"><em>file_writer</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Writes the object’s content. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">file_writer</td><td>The file writer to receive the object’s content.</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd><code>true</code> on success. <code>false</code> on error, indicating that the content could not be written to the minidump file.</dd></dl> |
| <dl class="section note"><dt>Note</dt><dd>Valid in <a class="el" href="classcrashpad_1_1internal_1_1MinidumpWritable.html#ac14e05f291f5fa713b5ec82a208fa7c7a87483823ca30a8257b2a5fbd21805bcd" title="The object is writable.">kStateWritable</a>. The object will transition to <a class="el" href="classcrashpad_1_1internal_1_1MinidumpWritable.html#ac14e05f291f5fa713b5ec82a208fa7c7af0d794ed29c320fcf35c71f40cc6a510" title="The object has been written to a minidump file.">kStateWritten</a> after this method returns. </dd></dl> |
| |
| <p>Implements <a class="el" href="classcrashpad_1_1internal_1_1MinidumpWritable.html#a2d3472b11ec3c12184f5d8f946fbb4a1">crashpad::internal::MinidumpWritable</a>.</p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following files:<ul> |
| <li>minidump/minidump_annotation_writer.h</li> |
| <li>minidump/minidump_annotation_writer.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> |
