<ahref="#pub-methods">Public Member Functions</a>|
<ahref="#pro-methods">Protected Member Functions</a>|
<ahref="classcrashpad_1_1MinidumpModuleCrashpadInfoWriter-members.html">List of all members</a></div>
<divclass="headertitle">
<divclass="title">crashpad::MinidumpModuleCrashpadInfoWriter 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_1MinidumpModuleCrashpadInfo.html"title="Additional Crashpad-specific information about a module carried within a minidump file...">MinidumpModuleCrashpadInfo</a> object in a minidump file.
<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,277,24"/>
<trclass="memdesc:aea1665a58aca942b2f46cf756ff5d312"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Initializes <aclass="el"href="structcrashpad_1_1MinidumpModuleCrashpadInfo.html"title="Additional Crashpad-specific information about a module carried within a minidump file...">MinidumpModuleCrashpadInfo</a> based on <em>module_snapshot</em>. <ahref="#aea1665a58aca942b2f46cf756ff5d312">More...</a><br/></td></tr>
<trclass="memdesc:a608dbfdcb0ce6a103477a9f728e9c410"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Arranges for <aclass="el"href="structcrashpad_1_1MinidumpModuleCrashpadInfo.html#a2ff38a7202adb5f8d3b8a3ede61ca4ec"title="A MinidumpRVAList pointing to MinidumpUTF8String objects. The module controls the data that appears h...">MinidumpModuleCrashpadInfo::list_annotations</a> to point to the internal::MinidumpUTF8StringListWriter object to be written by <em>list_annotations</em>. <ahref="#a608dbfdcb0ce6a103477a9f728e9c410">More...</a><br/></td></tr>
<trclass="memdesc:af746590dacef50ff08ecc4385afeb3ce"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Arranges for <aclass="el"href="structcrashpad_1_1MinidumpModuleCrashpadInfo.html#a6d064fcc880ad2933443f9f27e5f434a"title="A MinidumpSimpleStringDictionary pointing to strings interpreted as key-value pairs. The module controls the data that appears here. ">MinidumpModuleCrashpadInfo::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="#af746590dacef50ff08ecc4385afeb3ce">More...</a><br/></td></tr>
<trclass="memdesc:a5fd6ec497c5b5e630a135845346842bf"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Arranges for <aclass="el"href="structcrashpad_1_1MinidumpModuleCrashpadInfo.html#ac200fe528c804f9047d990470b840dc9"title="A MinidumpAnnotationList object containing the annotation objects stored within the module...">MinidumpModuleCrashpadInfo::annotation_objects</a> to point to the <aclass="el"href="classcrashpad_1_1MinidumpAnnotationListWriter.html"title="The writer for a MinidumpAnnotationList object in a minidump file, containing a list of MinidumpAnnot...">MinidumpAnnotationListWriter</a> object to be written by <em>annotation_objects</em>. <ahref="#a5fd6ec497c5b5e630a135845346842bf">More...</a><br/></td></tr>
<trclass="memdesc:af6eac706cc07729e88fc7f295f8aa9fb"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Determines whether the object is useful. <ahref="#af6eac706cc07729e88fc7f295f8aa9fb">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="classcrashpad_1_1internal_1_1MinidumpWritable.html#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="classcrashpad_1_1internal_1_1MinidumpWritable.html#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="classcrashpad_1_1internal_1_1MinidumpWritable.html#aed263c64ecb0597696d080e395af6400">More...</a><br/></td></tr>
<trclass="memdesc:a70e8a4ca07f2807a43d9a3a0f80aaf02"><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="#a70e8a4ca07f2807a43d9a3a0f80aaf02">More...</a><br/></td></tr>
<trclass="memdesc:a1e8d4da50da969e4d262cf94c826d477"><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="#a1e8d4da50da969e4d262cf94c826d477">More...</a><br/></td></tr>
<trclass="memdesc:ab1e60d25bb0dbe203c55f269205f80a7"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Returns the object’s children. <ahref="#ab1e60d25bb0dbe203c55f269205f80a7">More...</a><br/></td></tr>
<trclass="memdesc:a1d7c04c213d805e76571ff165eb53135"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Writes the object’s content. <ahref="#a1d7c04c213d805e76571ff165eb53135">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:aed27972114564f99cda1e7648aec807a inherit pro_methods_classcrashpad_1_1internal_1_1MinidumpWritable"><tdclass="mdescLeft"> </td><tdclass="mdescRight">The state of the object. <br/></td></tr>
<trclass="memdesc:a8439e05e21ccb78a4d61cd6e817d3bf5 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="classcrashpad_1_1internal_1_1MinidumpWritable.html#a8439e05e21ccb78a4d61cd6e817d3bf5">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="classcrashpad_1_1internal_1_1MinidumpWritable.html#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="classcrashpad_1_1internal_1_1MinidumpWritable.html#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:ac2b31049c4fedaabb24857d82531d6d6 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>. <br/></td></tr>
<divclass="textblock"><p>The writer for a <aclass="el"href="structcrashpad_1_1MinidumpModuleCrashpadInfo.html"title="Additional Crashpad-specific information about a module carried within a minidump file...">MinidumpModuleCrashpadInfo</a> object 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_1MinidumpModuleCrashpadInfoWriter.html#a70e8a4ca07f2807a43d9a3a0f80aaf02"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_1MinidumpModuleCrashpadInfoWriter.html#a70e8a4ca07f2807a43d9a3a0f80aaf02"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_1MinidumpModuleCrashpadInfo.html"title="Additional Crashpad-specific information about a module carried within a minidump file...">MinidumpModuleCrashpadInfo</a> based on <em>module_snapshot</em>. </p>
<p>Only data in <em>module_snapshot</em> that is considered useful will be included. For simple annotations, usefulness is determined by <aclass="el"href="classcrashpad_1_1MinidumpSimpleStringDictionaryWriter.html#ab86b79baa1f9a25fe63be298e644ad91"title="Determines whether the object is useful. ">MinidumpSimpleStringDictionaryWriter::IsUseful()</a>.</p>
<tr><tdclass="paramdir">[in]</td><tdclass="paramname">module_snapshot</td><td>The module 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 list annotations or simple annotations 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_1MinidumpModuleCrashpadInfo.html#ac200fe528c804f9047d990470b840dc9"title="A MinidumpAnnotationList object containing the annotation objects stored within the module...">MinidumpModuleCrashpadInfo::annotation_objects</a> to point to the <aclass="el"href="classcrashpad_1_1MinidumpAnnotationListWriter.html"title="The writer for a MinidumpAnnotationList object in a minidump file, containing a list of MinidumpAnnot...">MinidumpAnnotationListWriter</a> object to be written by <em>annotation_objects</em>. </p>
<p>This object takes ownership of <em>annotation_objects</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_1MinidumpModuleCrashpadInfo.html#a2ff38a7202adb5f8d3b8a3ede61ca4ec"title="A MinidumpRVAList pointing to MinidumpUTF8String objects. The module controls the data that appears h...">MinidumpModuleCrashpadInfo::list_annotations</a> to point to the internal::MinidumpUTF8StringListWriter object to be written by <em>list_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>Arranges for <aclass="el"href="structcrashpad_1_1MinidumpModuleCrashpadInfo.html#a6d064fcc880ad2933443f9f27e5f434a"title="A MinidumpSimpleStringDictionary pointing to strings interpreted as key-value pairs. The module controls the data that appears here. ">MinidumpModuleCrashpadInfo::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>
