| <!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::ImageAnnotationReader 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_1ImageAnnotationReader.html">ImageAnnotationReader</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="classcrashpad_1_1ImageAnnotationReader-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">crashpad::ImageAnnotationReader Class Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Reads Annotations from another process via a <a class="el" href="classcrashpad_1_1ProcessMemoryRange.html" title="Provides range protected access to the memory of another process.">ProcessMemoryRange</a>. |
| <a href="classcrashpad_1_1ImageAnnotationReader.html#details">More...</a></p> |
| |
| <p><code>#include "snapshot/crashpad_types/image_annotation_reader.h"</code></p> |
| <table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> |
| Public Member Functions</h2></td></tr> |
| <tr class="memitem:a41bb23a2f4bfea86bdc0649bfffc372b"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1ImageAnnotationReader.html#a41bb23a2f4bfea86bdc0649bfffc372b">ImageAnnotationReader</a> (const <a class="el" href="classcrashpad_1_1ProcessMemoryRange.html">ProcessMemoryRange</a> *memory)</td></tr> |
| <tr class="memdesc:a41bb23a2f4bfea86bdc0649bfffc372b"><td class="mdescLeft"> </td><td class="mdescRight">Constructs the object. <a href="classcrashpad_1_1ImageAnnotationReader.html#a41bb23a2f4bfea86bdc0649bfffc372b">More...</a><br /></td></tr> |
| <tr class="separator:a41bb23a2f4bfea86bdc0649bfffc372b"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:abd0347c3e4f7a1a735d12940d999850d"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1ImageAnnotationReader.html#abd0347c3e4f7a1a735d12940d999850d">SimpleMap</a> (<a class="el" href="namespacecrashpad.html#af2d003bfc8632755c60ab27bd6d1c8ae">VMAddress</a> address, std::map< std::string, std::string > *annotations) const</td></tr> |
| <tr class="memdesc:abd0347c3e4f7a1a735d12940d999850d"><td class="mdescLeft"> </td><td class="mdescRight">Reads annotations that are organized as key-value pairs, where all keys and values are strings. <a href="classcrashpad_1_1ImageAnnotationReader.html#abd0347c3e4f7a1a735d12940d999850d">More...</a><br /></td></tr> |
| <tr class="separator:abd0347c3e4f7a1a735d12940d999850d"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aa1bc778eab93458f252080e61a3a9a7d"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1ImageAnnotationReader.html#aa1bc778eab93458f252080e61a3a9a7d">AnnotationsList</a> (<a class="el" href="namespacecrashpad.html#af2d003bfc8632755c60ab27bd6d1c8ae">VMAddress</a>, std::vector< <a class="el" href="structcrashpad_1_1AnnotationSnapshot.html">AnnotationSnapshot</a> > *annotations) const</td></tr> |
| <tr class="memdesc:aa1bc778eab93458f252080e61a3a9a7d"><td class="mdescLeft"> </td><td class="mdescRight">Reads the module's annotations that are organized as a list of typed annotation objects. <a href="classcrashpad_1_1ImageAnnotationReader.html#aa1bc778eab93458f252080e61a3a9a7d">More...</a><br /></td></tr> |
| <tr class="separator:aa1bc778eab93458f252080e61a3a9a7d"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Reads Annotations from another process via a <a class="el" href="classcrashpad_1_1ProcessMemoryRange.html" title="Provides range protected access to the memory of another process.">ProcessMemoryRange</a>. </p> |
| <p>These annotations are stored for the benefit of crash reporters, and provide information thought to be potentially useful for crash analysis. </p> |
| </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a id="a41bb23a2f4bfea86bdc0649bfffc372b"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a41bb23a2f4bfea86bdc0649bfffc372b">◆ </a></span>ImageAnnotationReader()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">crashpad::ImageAnnotationReader::ImageAnnotationReader </td> |
| <td>(</td> |
| <td class="paramtype">const <a class="el" href="classcrashpad_1_1ProcessMemoryRange.html">ProcessMemoryRange</a> * </td> |
| <td class="paramname"><em>memory</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">explicit</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Constructs the object. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">memory</td><td>A memory reader for the remote process. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a id="aa1bc778eab93458f252080e61a3a9a7d"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aa1bc778eab93458f252080e61a3a9a7d">◆ </a></span>AnnotationsList()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool crashpad::ImageAnnotationReader::AnnotationsList </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="namespacecrashpad.html#af2d003bfc8632755c60ab27bd6d1c8ae">VMAddress</a> </td> |
| <td class="paramname"><em>address</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">std::vector< <a class="el" href="structcrashpad_1_1AnnotationSnapshot.html">AnnotationSnapshot</a> > * </td> |
| <td class="paramname"><em>annotations</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Reads the module's annotations that are organized as a list of typed annotation objects. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">address</td><td>The address in the target process' address space of an <a class="el" href="classcrashpad_1_1AnnotationList.html" title="A list that contains all the currently set annotations.">AnnotationList</a>. </td></tr> |
| <tr><td class="paramdir">[out]</td><td class="paramname">annotations</td><td>The annotations read, valid if this method returns <code>true</code>. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd><code>true</code> on success. <code>false</code> on failure with a message logged. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="abd0347c3e4f7a1a735d12940d999850d"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#abd0347c3e4f7a1a735d12940d999850d">◆ </a></span>SimpleMap()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool crashpad::ImageAnnotationReader::SimpleMap </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="namespacecrashpad.html#af2d003bfc8632755c60ab27bd6d1c8ae">VMAddress</a> </td> |
| <td class="paramname"><em>address</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">std::map< std::string, std::string > * </td> |
| <td class="paramname"><em>annotations</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Reads annotations that are organized as key-value pairs, where all keys and values are strings. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">address</td><td>The address in the target process' address space of a SimpleStringDictionary containing the annotations to read. </td></tr> |
| <tr><td class="paramdir">[out]</td><td class="paramname">annotations</td><td>The annotations read, valid if this method returns <code>true</code>. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd><code>true</code> on success. <code>false</code> on failure with a message logged. </dd></dl> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following files:<ul> |
| <li>snapshot/crashpad_types/image_annotation_reader.h</li> |
| <li>snapshot/crashpad_types/image_annotation_reader.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> |
