<!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.12"/> <meta name="viewport" content="width=device-width, initial-scale=1"/> <title>Crashpad: crashpad::MinidumpSimpleStringDictionaryEntryWriter 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.12 --> <script type="text/javascript"> var searchBox = new SearchBox("searchBox", "search",false,'Search'); </script> <script type="text/javascript" src="menudata.js"></script> <script type="text/javascript" src="menu.js"></script> <script type="text/javascript"> $(function() { initMenu('',true,false,'search.php','Search'); $(document).ready(function() { init_search(); }); }); </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_1MinidumpSimpleStringDictionaryEntryWriter.html">MinidumpSimpleStringDictionaryEntryWriter</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_1MinidumpSimpleStringDictionaryEntryWriter-members.html">List of all members</a> </div> <div class="headertitle"> <div class="title">crashpad::MinidumpSimpleStringDictionaryEntryWriter 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_1MinidumpSimpleStringDictionaryEntry.html" title="A key-value pair. ">MinidumpSimpleStringDictionaryEntry</a> object in a minidump file. <a href="classcrashpad_1_1MinidumpSimpleStringDictionaryEntryWriter.html#details">More...</a></p> <p><code>#include "minidump/minidump_simple_string_dictionary_writer.h"</code></p> <div class="dynheader"> Inheritance diagram for crashpad::MinidumpSimpleStringDictionaryEntryWriter:</div> <div class="dyncontent"> <div class="center"> <img src="classcrashpad_1_1MinidumpSimpleStringDictionaryEntryWriter.png" usemap="#crashpad::MinidumpSimpleStringDictionaryEntryWriter_map" alt=""/> <map id="crashpad::MinidumpSimpleStringDictionaryEntryWriter_map" name="crashpad::MinidumpSimpleStringDictionaryEntryWriter_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,317,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:a4f40a44af60e1137a2e3b98acdcda8b9"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="structcrashpad_1_1MinidumpSimpleStringDictionaryEntry.html">MinidumpSimpleStringDictionaryEntry</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1MinidumpSimpleStringDictionaryEntryWriter.html#a4f40a44af60e1137a2e3b98acdcda8b9">GetMinidumpSimpleStringDictionaryEntry</a> () const</td></tr> <tr class="memdesc:a4f40a44af60e1137a2e3b98acdcda8b9"><td class="mdescLeft"> </td><td class="mdescRight">Returns a <a class="el" href="structcrashpad_1_1MinidumpSimpleStringDictionaryEntry.html" title="A key-value pair. ">MinidumpSimpleStringDictionaryEntry</a> referencing this object’s data. <a href="#a4f40a44af60e1137a2e3b98acdcda8b9">More...</a><br /></td></tr> <tr class="separator:a4f40a44af60e1137a2e3b98acdcda8b9"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aa741e45117068b1b45aebce2a8d21a11"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1MinidumpSimpleStringDictionaryEntryWriter.html#aa741e45117068b1b45aebce2a8d21a11">SetKeyValue</a> (const std::string &key, const std::string &value)</td></tr> <tr class="memdesc:aa741e45117068b1b45aebce2a8d21a11"><td class="mdescLeft"> </td><td class="mdescRight">Sets the strings to be written as the entry object’s key and value. <a href="#aa741e45117068b1b45aebce2a8d21a11">More...</a><br /></td></tr> <tr class="separator:aa741e45117068b1b45aebce2a8d21a11"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a5cf119fdec75fd4165855b58ac70b11a"><td class="memItemLeft" align="right" valign="top">const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1MinidumpSimpleStringDictionaryEntryWriter.html#a5cf119fdec75fd4165855b58ac70b11a">Key</a> () const</td></tr> <tr class="memdesc:a5cf119fdec75fd4165855b58ac70b11a"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the key to be written. <a href="#a5cf119fdec75fd4165855b58ac70b11a">More...</a><br /></td></tr> <tr class="separator:a5cf119fdec75fd4165855b58ac70b11a"><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:af50ed884d5406d4bfbd3ac4a0b12bc83"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1MinidumpSimpleStringDictionaryEntryWriter.html#af50ed884d5406d4bfbd3ac4a0b12bc83">Freeze</a> () override</td></tr> <tr class="memdesc:af50ed884d5406d4bfbd3ac4a0b12bc83"><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="#af50ed884d5406d4bfbd3ac4a0b12bc83">More...</a><br /></td></tr> <tr class="separator:af50ed884d5406d4bfbd3ac4a0b12bc83"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a8e2119c11008b1332026ec0c15465c96"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1MinidumpSimpleStringDictionaryEntryWriter.html#a8e2119c11008b1332026ec0c15465c96">SizeOfObject</a> () override</td></tr> <tr class="memdesc:a8e2119c11008b1332026ec0c15465c96"><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="#a8e2119c11008b1332026ec0c15465c96">More...</a><br /></td></tr> <tr class="separator:a8e2119c11008b1332026ec0c15465c96"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a23abadbd5b069b0624618e980b8eea30"><td class="memItemLeft" align="right" valign="top">std::vector< MinidumpWritable * > </td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1MinidumpSimpleStringDictionaryEntryWriter.html#a23abadbd5b069b0624618e980b8eea30">Children</a> () override</td></tr> <tr class="memdesc:a23abadbd5b069b0624618e980b8eea30"><td class="mdescLeft"> </td><td class="mdescRight">Returns the object’s children. <a href="#a23abadbd5b069b0624618e980b8eea30">More...</a><br /></td></tr> <tr class="separator:a23abadbd5b069b0624618e980b8eea30"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a2b308901e5fdaac226c400b4da033c67"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1MinidumpSimpleStringDictionaryEntryWriter.html#a2b308901e5fdaac226c400b4da033c67">WriteObject</a> (<a class="el" href="classcrashpad_1_1FileWriterInterface.html">FileWriterInterface</a> *file_writer) override</td></tr> <tr class="memdesc:a2b308901e5fdaac226c400b4da033c67"><td class="mdescLeft"> </td><td class="mdescRight">Writes the object’s content. <a href="#a2b308901e5fdaac226c400b4da033c67">More...</a><br /></td></tr> <tr class="separator:a2b308901e5fdaac226c400b4da033c67"><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:a8439e05e21ccb78a4d61cd6e817d3bf5 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#a8439e05e21ccb78a4d61cd6e817d3bf5">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:a8439e05e21ccb78a4d61cd6e817d3bf5 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#a8439e05e21ccb78a4d61cd6e817d3bf5">More...</a><br /></td></tr> <tr class="separator:a8439e05e21ccb78a4d61cd6e817d3bf5 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> <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> </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> <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> </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:ae7c01f317a519213ac16bfeca94125d1 inherit pro_static_attribs_classcrashpad_1_1internal_1_1MinidumpWritable"><td class="memItemLeft" align="right" valign="top">static const size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1internal_1_1MinidumpWritable.html#ae7c01f317a519213ac16bfeca94125d1">kInvalidSize</a></td></tr> <tr class="memdesc:ae7c01f317a519213ac16bfeca94125d1 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>. <a href="classcrashpad_1_1internal_1_1MinidumpWritable.html#ae7c01f317a519213ac16bfeca94125d1">More...</a><br /></td></tr> <tr class="separator:ae7c01f317a519213ac16bfeca94125d1 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_1MinidumpSimpleStringDictionaryEntry.html" title="A key-value pair. ">MinidumpSimpleStringDictionaryEntry</a> object in a minidump file. </p> <p>Because <a class="el" href="structcrashpad_1_1MinidumpSimpleStringDictionaryEntry.html" title="A key-value pair. ">MinidumpSimpleStringDictionaryEntry</a> objects only appear as elements of <a class="el" href="structcrashpad_1_1MinidumpSimpleStringDictionary.html" title="A list of key-value pairs. ">MinidumpSimpleStringDictionary</a> objects, this class does not write any data on its own. It makes its <a class="el" href="structcrashpad_1_1MinidumpSimpleStringDictionaryEntry.html" title="A key-value pair. ">MinidumpSimpleStringDictionaryEntry</a> data available to its <a class="el" href="classcrashpad_1_1MinidumpSimpleStringDictionaryWriter.html" title="The writer for a MinidumpSimpleStringDictionary object in a minidump file, containing a list of Minid...">MinidumpSimpleStringDictionaryWriter</a> parent, which writes it as part of a <a class="el" href="structcrashpad_1_1MinidumpSimpleStringDictionary.html" title="A list of key-value pairs. ">MinidumpSimpleStringDictionary</a>. </p> </div><h2 class="groupheader">Member Function Documentation</h2> <a id="a23abadbd5b069b0624618e980b8eea30"></a> <h2 class="memtitle"><span class="permalink"><a href="#a23abadbd5b069b0624618e980b8eea30">§ </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::MinidumpSimpleStringDictionaryEntryWriter::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="af50ed884d5406d4bfbd3ac4a0b12bc83"></a> <h2 class="memtitle"><span class="permalink"><a href="#af50ed884d5406d4bfbd3ac4a0b12bc83">§ </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::MinidumpSimpleStringDictionaryEntryWriter::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_1MinidumpSimpleStringDictionaryEntryWriter.html#af50ed884d5406d4bfbd3ac4a0b12bc83" 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_1MinidumpSimpleStringDictionaryEntryWriter.html#af50ed884d5406d4bfbd3ac4a0b12bc83" 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="a4f40a44af60e1137a2e3b98acdcda8b9"></a> <h2 class="memtitle"><span class="permalink"><a href="#a4f40a44af60e1137a2e3b98acdcda8b9">§ </a></span>GetMinidumpSimpleStringDictionaryEntry()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const <a class="el" href="structcrashpad_1_1MinidumpSimpleStringDictionaryEntry.html">MinidumpSimpleStringDictionaryEntry</a> * crashpad::MinidumpSimpleStringDictionaryEntryWriter::GetMinidumpSimpleStringDictionaryEntry </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </div><div class="memdoc"> <p>Returns a <a class="el" href="structcrashpad_1_1MinidumpSimpleStringDictionaryEntry.html" title="A key-value pair. ">MinidumpSimpleStringDictionaryEntry</a> referencing this object’s data. </p> <p>This method is expected to be called by a <a class="el" href="classcrashpad_1_1MinidumpSimpleStringDictionaryWriter.html" title="The writer for a MinidumpSimpleStringDictionary object in a minidump file, containing a list of Minid...">MinidumpSimpleStringDictionaryWriter</a> in order to obtain a <a class="el" href="structcrashpad_1_1MinidumpSimpleStringDictionaryEntry.html" title="A key-value pair. ">MinidumpSimpleStringDictionaryEntry</a> to include in its list.</p> <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>. </dd></dl> </div> </div> <a id="a5cf119fdec75fd4165855b58ac70b11a"></a> <h2 class="memtitle"><span class="permalink"><a href="#a5cf119fdec75fd4165855b58ac70b11a">§ </a></span>Key()</h2> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">const std::string& crashpad::MinidumpSimpleStringDictionaryEntryWriter::Key </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>Retrieves the key to be written. </p> <dl class="section note"><dt>Note</dt><dd>Valid in any state. </dd></dl> </div> </div> <a id="aa741e45117068b1b45aebce2a8d21a11"></a> <h2 class="memtitle"><span class="permalink"><a href="#aa741e45117068b1b45aebce2a8d21a11">§ </a></span>SetKeyValue()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void crashpad::MinidumpSimpleStringDictionaryEntryWriter::SetKeyValue </td> <td>(</td> <td class="paramtype">const std::string & </td> <td class="paramname"><em>key</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const std::string & </td> <td class="paramname"><em>value</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Sets the strings to be written as the entry object’s key and value. </p> <dl class="section note"><dt>Note</dt><dd>Valid in <a class="el" href="classcrashpad_1_1internal_1_1MinidumpWritable.html#ac14e05f291f5fa713b5ec82a208fa7c7a18337604dcbdbdb23ed51810f0587665" title="The object’s properties can be modified. ">kStateMutable</a>. </dd></dl> </div> </div> <a id="a8e2119c11008b1332026ec0c15465c96"></a> <h2 class="memtitle"><span class="permalink"><a href="#a8e2119c11008b1332026ec0c15465c96">§ </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::MinidumpSimpleStringDictionaryEntryWriter::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="a2b308901e5fdaac226c400b4da033c67"></a> <h2 class="memtitle"><span class="permalink"><a href="#a2b308901e5fdaac226c400b4da033c67">§ </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::MinidumpSimpleStringDictionaryEntryWriter::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_simple_string_dictionary_writer.h</li> <li>minidump/minidump_simple_string_dictionary_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.12 </small></address> </body> </html>