<ahref="#pub-methods">Public Member Functions</a>|
<ahref="#pro-methods">Protected Member Functions</a>|
<ahref="classcrashpad_1_1MinidumpCrashpadInfoWriter-members.html">List of all members</a></div>
<divclass="headertitle">
<divclass="title">crashpad::MinidumpCrashpadInfoWriter Class Reference<spanclass="mlabels"><spanclass="mlabel">final</span></span></div></div>
</div><!--header-->
<divclass="contents">
<p>The writer for a <aclass="el"href="structcrashpad_1_1MinidumpCrashpadInfo.html"title="Additional Crashpad-specific information carried within a minidump file. ">MinidumpCrashpadInfo</a> stream in a minidump file.
<areahref="classcrashpad_1_1internal_1_1MinidumpStreamWriter.html"title="The base class for all second-level objects (“streams”) in a minidump file. "alt="crashpad::internal::MinidumpStreamWriter"shape="rect"coords="0,56,246,80"/>
<areahref="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,246,24"/>
<trclass="memdesc:a14eb75b890f579a1f362531bcf04649f"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Initializes <aclass="el"href="structcrashpad_1_1MinidumpCrashpadInfo.html"title="Additional Crashpad-specific information carried within a minidump file. ">MinidumpCrashpadInfo</a> based on <em>process_snapshot</em>. <ahref="#a14eb75b890f579a1f362531bcf04649f">More...</a><br/></td></tr>
<trclass="memdesc:a38f469dc3d87b7319a5d60c3404f9ee9"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Sets <aclass="el"href="structcrashpad_1_1MinidumpCrashpadInfo.html#ad83ed0b5dd10f4ddaf138caf96861b97"title="A UUID identifying the client that crashed. ">MinidumpCrashpadInfo::client_id</a>. <br/></td></tr>
<trclass="memdesc:a00931a1910f05b5904be7ea18648fae3"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Arranges for <aclass="el"href="structcrashpad_1_1MinidumpCrashpadInfo.html#a8a6300d72ebb8dab13ca50947e37348f"title="A MinidumpSimpleStringDictionary pointing to strings interpreted as key-value pairs. ">MinidumpCrashpadInfo::simple_annotations</a> to point to the <aclass="el"href="classcrashpad_1_1MinidumpSimpleStringDictionaryWriter.html"title="The writer for a MinidumpSimpleStringDictionary object in a minidump file, containing a list of Minid...">MinidumpSimpleStringDictionaryWriter</a> object to be written by <em>simple_annotations</em>. <ahref="#a00931a1910f05b5904be7ea18648fae3">More...</a><br/></td></tr>
<trclass="memdesc:ab5b68c3d89eca45b73bf008974bca5ad"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Arranges for <aclass="el"href="structcrashpad_1_1MinidumpCrashpadInfo.html#a343f824f5f16c241eb8ff11b71cf39ec"title="A pointer to a #MinidumpModuleCrashpadInfoList structure. ">MinidumpCrashpadInfo::module_list</a> to point to the <aclass="el"href="structcrashpad_1_1MinidumpModuleCrashpadInfoList.html"title="Additional Crashpad-specific information about modules carried within a minidump file. ">MinidumpModuleCrashpadInfoList</a> object to be written by <em>module_list</em>. <ahref="#ab5b68c3d89eca45b73bf008974bca5ad">More...</a><br/></td></tr>
<trclass="memdesc:aeb0829f100985e182a624a607e571608"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Determines whether the object is useful. <ahref="#aeb0829f100985e182a624a607e571608">More...</a><br/></td></tr>
<trclass="inherit_header pub_methods_classcrashpad_1_1internal_1_1MinidumpStreamWriter"><tdcolspan="2"onclick="javascript:toggleInherit('pub_methods_classcrashpad_1_1internal_1_1MinidumpStreamWriter')"><imgsrc="closed.png"alt="-"/> Public Member Functions inherited from <aclass="el"href="classcrashpad_1_1internal_1_1MinidumpStreamWriter.html">crashpad::internal::MinidumpStreamWriter</a></td></tr>
<trclass="memdesc:a2c36492670110f546faaddd9e49d4344 inherit pub_methods_classcrashpad_1_1internal_1_1MinidumpStreamWriter"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Returns a <aclass="el"href="structMINIDUMP__DIRECTORY.html"title="A pointer to a stream within a minidump file. ">MINIDUMP_DIRECTORY</a> entry that serves as a pointer to this stream. <ahref="#a2c36492670110f546faaddd9e49d4344">More...</a><br/></td></tr>
<trclass="inherit_header pub_methods_classcrashpad_1_1internal_1_1MinidumpWritable"><tdcolspan="2"onclick="javascript:toggleInherit('pub_methods_classcrashpad_1_1internal_1_1MinidumpWritable')"><imgsrc="closed.png"alt="-"/> Public Member Functions inherited from <aclass="el"href="classcrashpad_1_1internal_1_1MinidumpWritable.html">crashpad::internal::MinidumpWritable</a></td></tr>
<trclass="memdesc:a24507e918299cb566c7f15207de83a7f inherit pub_methods_classcrashpad_1_1internal_1_1MinidumpWritable"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Writes an object and all of its children to a minidump file. <ahref="#a24507e918299cb566c7f15207de83a7f">More...</a><br/></td></tr>
<trclass="memdesc:a686683d78f099a07e2a1df8e6b567d37 inherit pub_methods_classcrashpad_1_1internal_1_1MinidumpWritable"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Registers a file offset pointer as one that should point to the object on which this method is called. <ahref="#a686683d78f099a07e2a1df8e6b567d37">More...</a><br/></td></tr>
<trclass="memdesc:aed263c64ecb0597696d080e395af6400 inherit pub_methods_classcrashpad_1_1internal_1_1MinidumpWritable"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Registers a location descriptor as one that should point to the object on which this method is called. <ahref="#aed263c64ecb0597696d080e395af6400">More...</a><br/></td></tr>
<trclass="memdesc:a94b22bb7492af0d870d5322c213e518b"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Transitions the object from <aclass="el"href="classcrashpad_1_1internal_1_1MinidumpWritable.html#ac14e05f291f5fa713b5ec82a208fa7c7a18337604dcbdbdb23ed51810f0587665"title="The object’s properties can be modified. ">kStateMutable</a> to <aclass="el"href="classcrashpad_1_1internal_1_1MinidumpWritable.html#ac14e05f291f5fa713b5ec82a208fa7c7af98547144e0e8d4f878f725ef5c0d611"title="The object is “frozen”. ">kStateFrozen</a>. <ahref="#a94b22bb7492af0d870d5322c213e518b">More...</a><br/></td></tr>
<trclass="memdesc:a0a1d4e65cc2f3a6397e3bd90312cdf11"><tdclass="mdescLeft"> </td><tdclass="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. <ahref="#a0a1d4e65cc2f3a6397e3bd90312cdf11">More...</a><br/></td></tr>
<trclass="memdesc:af90d8aef42effdbb3db96878bdf4cc47"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Returns the object’s children. <ahref="#af90d8aef42effdbb3db96878bdf4cc47">More...</a><br/></td></tr>
<trclass="memdesc:a438010ef37056aaeba48f26680265cfa"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Writes the object’s content. <ahref="#a438010ef37056aaeba48f26680265cfa">More...</a><br/></td></tr>
<trclass="inherit_header pro_methods_classcrashpad_1_1internal_1_1MinidumpStreamWriter"><tdcolspan="2"onclick="javascript:toggleInherit('pro_methods_classcrashpad_1_1internal_1_1MinidumpStreamWriter')"><imgsrc="closed.png"alt="-"/> Protected Member Functions inherited from <aclass="el"href="classcrashpad_1_1internal_1_1MinidumpStreamWriter.html">crashpad::internal::MinidumpStreamWriter</a></td></tr>
<trclass="memdesc:a6bace0c62b1f29aa710974a2bbcb3e1c inherit pro_methods_classcrashpad_1_1internal_1_1MinidumpStreamWriter"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Transitions the object from <aclass="el"href="classcrashpad_1_1internal_1_1MinidumpWritable.html#ac14e05f291f5fa713b5ec82a208fa7c7a18337604dcbdbdb23ed51810f0587665"title="The object’s properties can be modified. ">kStateMutable</a> to <aclass="el"href="classcrashpad_1_1internal_1_1MinidumpWritable.html#ac14e05f291f5fa713b5ec82a208fa7c7af98547144e0e8d4f878f725ef5c0d611"title="The object is “frozen”. ">kStateFrozen</a>. <ahref="#a6bace0c62b1f29aa710974a2bbcb3e1c">More...</a><br/></td></tr>
<trclass="inherit_header pro_methods_classcrashpad_1_1internal_1_1MinidumpWritable"><tdcolspan="2"onclick="javascript:toggleInherit('pro_methods_classcrashpad_1_1internal_1_1MinidumpWritable')"><imgsrc="closed.png"alt="-"/> Protected Member Functions inherited from <aclass="el"href="classcrashpad_1_1internal_1_1MinidumpWritable.html">crashpad::internal::MinidumpWritable</a></td></tr>
<trclass="memdesc:a665d2de47970d796e904f0dfce406814 inherit pro_methods_classcrashpad_1_1internal_1_1MinidumpWritable"><tdclass="mdescLeft"> </td><tdclass="mdescRight">The state of the object. <br/></td></tr>
<trclass="memdesc:a712fac2ada227f53c55eb0c4d042f239 inherit pro_methods_classcrashpad_1_1internal_1_1MinidumpWritable"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Prepares the object to be written at a known file offset, transitioning it from <aclass="el"href="classcrashpad_1_1internal_1_1MinidumpWritable.html#ac14e05f291f5fa713b5ec82a208fa7c7af98547144e0e8d4f878f725ef5c0d611"title="The object is “frozen”. ">kStateFrozen</a> to <aclass="el"href="classcrashpad_1_1internal_1_1MinidumpWritable.html#ac14e05f291f5fa713b5ec82a208fa7c7a87483823ca30a8257b2a5fbd21805bcd"title="The object is writable. ">kStateWritable</a>. <ahref="#a712fac2ada227f53c55eb0c4d042f239">More...</a><br/></td></tr>
<trclass="memdesc:a2416cb821816b769d95b92e486713ebf inherit pro_methods_classcrashpad_1_1internal_1_1MinidumpWritable"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Called once an object’s writable file offset is determined, as it transitions into <aclass="el"href="classcrashpad_1_1internal_1_1MinidumpWritable.html#ac14e05f291f5fa713b5ec82a208fa7c7a87483823ca30a8257b2a5fbd21805bcd"title="The object is writable. ">kStateWritable</a>. <ahref="#a2416cb821816b769d95b92e486713ebf">More...</a><br/></td></tr>
<trclass="memdesc:ab82b1e92ae0eced8b8e2efe957411773 inherit pro_methods_classcrashpad_1_1internal_1_1MinidumpWritable"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Writes the object, transitioning it from <aclass="el"href="classcrashpad_1_1internal_1_1MinidumpWritable.html#ac14e05f291f5fa713b5ec82a208fa7c7a87483823ca30a8257b2a5fbd21805bcd"title="The object is writable. ">kStateWritable</a> to <aclass="el"href="classcrashpad_1_1internal_1_1MinidumpWritable.html#ac14e05f291f5fa713b5ec82a208fa7c7af0d794ed29c320fcf35c71f40cc6a510"title="The object has been written to a minidump file. ">kStateWritten</a>. <ahref="#ab82b1e92ae0eced8b8e2efe957411773">More...</a><br/></td></tr>
<trclass="memitem:ac14e05f291f5fa713b5ec82a208fa7c7 inherit pro_types_classcrashpad_1_1internal_1_1MinidumpWritable"><tdclass="memItemLeft"align="right"valign="top">enum  </td><tdclass="memItemRight"valign="bottom"><aclass="el"href="classcrashpad_1_1internal_1_1MinidumpWritable.html#ac14e05f291f5fa713b5ec82a208fa7c7">State</a><trclass="memdesc:ac14e05f291f5fa713b5ec82a208fa7c7"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Identifies the state of an object. <ahref="classcrashpad_1_1internal_1_1MinidumpWritable.html#ac14e05f291f5fa713b5ec82a208fa7c7">More...</a><br/></td></tr>
<trclass="memitem:a009f007265d64a5fb416848480a00ae9 inherit pro_types_classcrashpad_1_1internal_1_1MinidumpWritable"><tdclass="memItemLeft"align="right"valign="top">enum  </td><tdclass="memItemRight"valign="bottom"><aclass="el"href="classcrashpad_1_1internal_1_1MinidumpWritable.html#a009f007265d64a5fb416848480a00ae9">Phase</a><trclass="memdesc:a009f007265d64a5fb416848480a00ae9"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Identifies the phase during which an object will be written to a minidump file. <ahref="classcrashpad_1_1internal_1_1MinidumpWritable.html#a009f007265d64a5fb416848480a00ae9">More...</a><br/></td></tr>
<trclass="memdesc:ae7c01f317a519213ac16bfeca94125d1 inherit pro_static_attribs_classcrashpad_1_1internal_1_1MinidumpWritable"><tdclass="mdescLeft"> </td><tdclass="mdescRight">A size value used to signal failure by methods that return <code>size_t</code>. <ahref="#ae7c01f317a519213ac16bfeca94125d1">More...</a><br/></td></tr>
<divclass="textblock"><p>The writer for a <aclass="el"href="structcrashpad_1_1MinidumpCrashpadInfo.html"title="Additional Crashpad-specific information carried within a minidump file. ">MinidumpCrashpadInfo</a> stream in a minidump file. </p>
</div><h2class="groupheader">Member Function Documentation</h2>
<dlclass="section note"><dt>Note</dt><dd>Valid in <aclass="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 <aclass="el"href="classcrashpad_1_1internal_1_1MinidumpWritable.html#a32460b7fe2154fbabc3c58bf10dc7861">crashpad::internal::MinidumpWritable</a>.</p>
<p>Transitions the object from <aclass="el"href="classcrashpad_1_1internal_1_1MinidumpWritable.html#ac14e05f291f5fa713b5ec82a208fa7c7a18337604dcbdbdb23ed51810f0587665"title="The object’s properties can be modified. ">kStateMutable</a> to <aclass="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 <aclass="el"href="classcrashpad_1_1MinidumpCrashpadInfoWriter.html#a94b22bb7492af0d870d5322c213e518b"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 <aclass="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 <aclass="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 <aclass="el"href="classcrashpad_1_1MinidumpCrashpadInfoWriter.html#a94b22bb7492af0d870d5322c213e518b"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>
<dlclass="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 <aclass="el"href="classcrashpad_1_1internal_1_1MinidumpWritable.html#a773db80946a99c6a3cc29c7d4dd77bd6">crashpad::internal::MinidumpWritable</a>.</p>
<p>Initializes <aclass="el"href="structcrashpad_1_1MinidumpCrashpadInfo.html"title="Additional Crashpad-specific information carried within a minidump file. ">MinidumpCrashpadInfo</a> based on <em>process_snapshot</em>. </p>
<p>This method may add additional structures to the minidump file as children of the <aclass="el"href="structcrashpad_1_1MinidumpCrashpadInfo.html"title="Additional Crashpad-specific information carried within a minidump file. ">MinidumpCrashpadInfo</a> stream. To do so, it may obtain other snapshot information from <em>process_snapshot</em>, such as a list of <aclass="el"href="classcrashpad_1_1ModuleSnapshot.html"title="An abstract interface to a snapshot representing a code module (binary image) loaded into a snapshot ...">ModuleSnapshot</a> objects used to initialize <aclass="el"href="structcrashpad_1_1MinidumpCrashpadInfo.html#a343f824f5f16c241eb8ff11b71cf39ec"title="A pointer to a #MinidumpModuleCrashpadInfoList structure. ">MinidumpCrashpadInfo::module_list</a>. Only data that is considered useful will be included. For module information, usefulness is determined by <aclass="el"href="classcrashpad_1_1MinidumpModuleCrashpadInfoListWriter.html#a190af330f8f86496e974621f6b63d19e"title="Determines whether the object is useful. ">MinidumpModuleCrashpadInfoListWriter::IsUseful()</a>.</p>
<dlclass="params"><dt>Parameters</dt><dd>
<tableclass="params">
<tr><tdclass="paramdir">[in]</td><tdclass="paramname">process_snapshot</td><td>The process snapshot to use as source data.</td></tr>
</table>
</dd>
</dl>
<dlclass="section note"><dt>Note</dt><dd>Valid in <aclass="el"href="classcrashpad_1_1internal_1_1MinidumpWritable.html#ac14e05f291f5fa713b5ec82a208fa7c7a18337604dcbdbdb23ed51810f0587665"title="The object’s properties can be modified. ">kStateMutable</a>. No mutator methods may be called before this method, and it is not normally necessary to call any mutator methods after this method. </dd></dl>
<p>A useful object is one that carries data that makes a meaningful contribution to a minidump file. An object carrying children would be considered useful.</p>
<dlclass="section return"><dt>Returns</dt><dd><code>true</code> if the object is useful, <code>false</code> otherwise. </dd></dl>
<p>Arranges for <aclass="el"href="structcrashpad_1_1MinidumpCrashpadInfo.html#a343f824f5f16c241eb8ff11b71cf39ec"title="A pointer to a #MinidumpModuleCrashpadInfoList structure. ">MinidumpCrashpadInfo::module_list</a> to point to the <aclass="el"href="structcrashpad_1_1MinidumpModuleCrashpadInfoList.html"title="Additional Crashpad-specific information about modules carried within a minidump file. ">MinidumpModuleCrashpadInfoList</a> object to be written by <em>module_list</em>. </p>
<p>This object takes ownership of <em>module_list</em> and becomes its parent in the overall tree of <aclass="el"href="classcrashpad_1_1internal_1_1MinidumpWritable.html"title="The base class for all content that might be written to a minidump file. ">internal::MinidumpWritable</a> objects.</p>
<dlclass="section note"><dt>Note</dt><dd>Valid in <aclass="el"href="classcrashpad_1_1internal_1_1MinidumpWritable.html#ac14e05f291f5fa713b5ec82a208fa7c7a18337604dcbdbdb23ed51810f0587665"title="The object’s properties can be modified. ">kStateMutable</a>. </dd></dl>
<p>Arranges for <aclass="el"href="structcrashpad_1_1MinidumpCrashpadInfo.html#a8a6300d72ebb8dab13ca50947e37348f"title="A MinidumpSimpleStringDictionary pointing to strings interpreted as key-value pairs. ">MinidumpCrashpadInfo::simple_annotations</a> to point to the <aclass="el"href="classcrashpad_1_1MinidumpSimpleStringDictionaryWriter.html"title="The writer for a MinidumpSimpleStringDictionary object in a minidump file, containing a list of Minid...">MinidumpSimpleStringDictionaryWriter</a> object to be written by <em>simple_annotations</em>. </p>
<p>This object takes ownership of <em>simple_annotations</em> and becomes its parent in the overall tree of <aclass="el"href="classcrashpad_1_1internal_1_1MinidumpWritable.html"title="The base class for all content that might be written to a minidump file. ">internal::MinidumpWritable</a> objects.</p>
<dlclass="section note"><dt>Note</dt><dd>Valid in <aclass="el"href="classcrashpad_1_1internal_1_1MinidumpWritable.html#ac14e05f291f5fa713b5ec82a208fa7c7a18337604dcbdbdb23ed51810f0587665"title="The object’s properties can be modified. ">kStateMutable</a>. </dd></dl>
<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>
<dlclass="section note"><dt>Note</dt><dd>Valid in <aclass="el"href="classcrashpad_1_1internal_1_1MinidumpWritable.html#ac14e05f291f5fa713b5ec82a208fa7c7af98547144e0e8d4f878f725ef5c0d611"title="The object is “frozen”. ">kStateFrozen</a> or any subsequent state. </dd></dl>
<tr><tdclass="paramdir">[in]</td><tdclass="paramname">file_writer</td><td>The file writer to receive the object’s content.</td></tr>
</table>
</dd>
</dl>
<dlclass="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>
<dlclass="section note"><dt>Note</dt><dd>Valid in <aclass="el"href="classcrashpad_1_1internal_1_1MinidumpWritable.html#ac14e05f291f5fa713b5ec82a208fa7c7a87483823ca30a8257b2a5fbd21805bcd"title="The object is writable. ">kStateWritable</a>. The object will transition to <aclass="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>
