<!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.9.1"/> <title>Crashpad: crashpad::internal::ThreadSnapshotWin 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> <script type="text/javascript"> $(document).ready(function() { init_search(); }); </script> <link href="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 style="padding-left: 0.5em;"> <div id="projectname">Crashpad </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.9.1 --> <script type="text/javascript"> var searchBox = new SearchBox("searchBox", "search",false,'Search'); </script> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li class="current"><a href="annotated.html"><span>Classes</span></a></li> <li><a href="files.html"><span>Files</span></a></li> <li> <div id="MSearchBox" class="MSearchBoxInactive"> <span class="left"> <img id="MSearchSelect" src="search/mag_sel.png" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" alt=""/> <input type="text" id="MSearchField" value="Search" accesskey="S" onfocus="searchBox.OnSearchFieldFocus(true)" onblur="searchBox.OnSearchFieldFocus(false)" onkeyup="searchBox.OnSearchFieldChange(event)"/> </span><span class="right"> <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> </span> </div> </li> </ul> </div> <div id="navrow2" class="tabs2"> <ul class="tablist"> <li><a href="annotated.html"><span>Class List</span></a></li> <li><a href="classes.html"><span>Class Index</span></a></li> <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul> </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="namespacecrashpad_1_1internal.html">internal</a></li><li class="navelem"><a class="el" href="classcrashpad_1_1internal_1_1ThreadSnapshotWin.html">ThreadSnapshotWin</a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="summary"> <a href="#pub-methods">Public Member Functions</a> | <a href="classcrashpad_1_1internal_1_1ThreadSnapshotWin-members.html">List of all members</a> </div> <div class="headertitle"> <div class="title">crashpad::internal::ThreadSnapshotWin Class Reference<span class="mlabels"><span class="mlabel">final</span></span></div> </div> </div><!--header--> <div class="contents"> <p>A <a class="el" href="classcrashpad_1_1ThreadSnapshot.html" title="An abstract interface to a snapshot representing a thread (lightweight process) present in a snapshot...">ThreadSnapshot</a> of a thread in a running (or crashed) process on a Windows system. <a href="classcrashpad_1_1internal_1_1ThreadSnapshotWin.html#details">More...</a></p> <p><code>#include "snapshot/win/thread_snapshot_win.h"</code></p> <div class="dynheader"> Inheritance diagram for crashpad::internal::ThreadSnapshotWin:</div> <div class="dyncontent"> <div class="center"> <img src="classcrashpad_1_1internal_1_1ThreadSnapshotWin.png" usemap="#crashpad::internal::ThreadSnapshotWin_map" alt=""/> <map id="crashpad::internal::ThreadSnapshotWin_map" name="crashpad::internal::ThreadSnapshotWin_map"> <area href="classcrashpad_1_1ThreadSnapshot.html" title="An abstract interface to a snapshot representing a thread (lightweight process) present in a snapshot..." alt="crashpad::ThreadSnapshot" shape="rect" coords="0,0,351,24"/> <area href="classcrashpad_1_1PointerContainer.html" alt="crashpad::PointerContainer< internal::ThreadSnapshotWin >" shape="rect" coords="0,112,351,136"/> </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:ab480db58d2bc69f82e5db5fef5b3592d"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1internal_1_1ThreadSnapshotWin.html#ab480db58d2bc69f82e5db5fef5b3592d">Initialize</a> (<a class="el" href="classcrashpad_1_1ProcessReaderWin.html">ProcessReaderWin</a> *process_reader, const <a class="el" href="structcrashpad_1_1ProcessReaderWin_1_1Thread.html">ProcessReaderWin::Thread</a> &process_reader_thread)</td></tr> <tr class="memdesc:ab480db58d2bc69f82e5db5fef5b3592d"><td class="mdescLeft"> </td><td class="mdescRight">Initializes the object. <a href="#ab480db58d2bc69f82e5db5fef5b3592d">More...</a><br /></td></tr> <tr class="separator:ab480db58d2bc69f82e5db5fef5b3592d"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a940a3771e98c08da18307b2309ca7357"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="structcrashpad_1_1CPUContext.html">CPUContext</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1internal_1_1ThreadSnapshotWin.html#a940a3771e98c08da18307b2309ca7357">Context</a> () const override</td></tr> <tr class="memdesc:a940a3771e98c08da18307b2309ca7357"><td class="mdescLeft"> </td><td class="mdescRight">Returns a <a class="el" href="structcrashpad_1_1CPUContext.html" title="A context structure capable of carrying the context of any supported CPU architecture. ">CPUContext</a> object corresponding to the thread’s CPU context. <a href="#a940a3771e98c08da18307b2309ca7357">More...</a><br /></td></tr> <tr class="separator:a940a3771e98c08da18307b2309ca7357"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ac069bf4439cbb2be3b243460d7717826"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classcrashpad_1_1MemorySnapshot.html">MemorySnapshot</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1internal_1_1ThreadSnapshotWin.html#ac069bf4439cbb2be3b243460d7717826">Stack</a> () const override</td></tr> <tr class="memdesc:ac069bf4439cbb2be3b243460d7717826"><td class="mdescLeft"> </td><td class="mdescRight">Returns a <a class="el" href="classcrashpad_1_1MemorySnapshot.html" title="An abstract interface to a snapshot representing a region of memory present in a snapshot process...">MemorySnapshot</a> object corresponding to the memory region that contains the thread’s stack, or <code>nullptr</code> if no stack region is available. <a href="#ac069bf4439cbb2be3b243460d7717826">More...</a><br /></td></tr> <tr class="separator:ac069bf4439cbb2be3b243460d7717826"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aaedbdde56b7ba7c6c271758da0fcb1e2"><td class="memItemLeft" align="right" valign="top">uint64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1internal_1_1ThreadSnapshotWin.html#aaedbdde56b7ba7c6c271758da0fcb1e2">ThreadID</a> () const override</td></tr> <tr class="memdesc:aaedbdde56b7ba7c6c271758da0fcb1e2"><td class="mdescLeft"> </td><td class="mdescRight">Returns the thread’s identifier. <a href="#aaedbdde56b7ba7c6c271758da0fcb1e2">More...</a><br /></td></tr> <tr class="separator:aaedbdde56b7ba7c6c271758da0fcb1e2"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ad0f0966f362f6e02f59d3aa436990a15"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1internal_1_1ThreadSnapshotWin.html#ad0f0966f362f6e02f59d3aa436990a15">SuspendCount</a> () const override</td></tr> <tr class="memdesc:ad0f0966f362f6e02f59d3aa436990a15"><td class="mdescLeft"> </td><td class="mdescRight">Returns the thread’s suspend count. <a href="#ad0f0966f362f6e02f59d3aa436990a15">More...</a><br /></td></tr> <tr class="separator:ad0f0966f362f6e02f59d3aa436990a15"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a84dae6824c9bda4fe6d459ea032dd28a"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1internal_1_1ThreadSnapshotWin.html#a84dae6824c9bda4fe6d459ea032dd28a">Priority</a> () const override</td></tr> <tr class="memdesc:a84dae6824c9bda4fe6d459ea032dd28a"><td class="mdescLeft"> </td><td class="mdescRight">Returns the thread’s priority. <a href="#a84dae6824c9bda4fe6d459ea032dd28a">More...</a><br /></td></tr> <tr class="separator:a84dae6824c9bda4fe6d459ea032dd28a"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ac1d36f879e8f4ccc6e195b4ef64cf1c7"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac1d36f879e8f4ccc6e195b4ef64cf1c7"></a> uint64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1internal_1_1ThreadSnapshotWin.html#ac1d36f879e8f4ccc6e195b4ef64cf1c7">ThreadSpecificDataAddress</a> () const override</td></tr> <tr class="memdesc:ac1d36f879e8f4ccc6e195b4ef64cf1c7"><td class="mdescLeft"> </td><td class="mdescRight">Returns the base address of a region used to store thread-specific data. <br /></td></tr> <tr class="separator:ac1d36f879e8f4ccc6e195b4ef64cf1c7"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a00c30606d4e1a7a8f43b4c89b3fc4e8e"><td class="memItemLeft" align="right" valign="top">std::vector< const <a class="el" href="classcrashpad_1_1MemorySnapshot.html">MemorySnapshot</a> * > </td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1internal_1_1ThreadSnapshotWin.html#a00c30606d4e1a7a8f43b4c89b3fc4e8e">ExtraMemory</a> () const override</td></tr> <tr class="memdesc:a00c30606d4e1a7a8f43b4c89b3fc4e8e"><td class="mdescLeft"> </td><td class="mdescRight">Returns a vector of additional memory blocks that should be included in a minidump. <a href="#a00c30606d4e1a7a8f43b4c89b3fc4e8e">More...</a><br /></td></tr> <tr class="separator:a00c30606d4e1a7a8f43b4c89b3fc4e8e"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><p>A <a class="el" href="classcrashpad_1_1ThreadSnapshot.html" title="An abstract interface to a snapshot representing a thread (lightweight process) present in a snapshot...">ThreadSnapshot</a> of a thread in a running (or crashed) process on a Windows system. </p> </div><h2 class="groupheader">Member Function Documentation</h2> <a class="anchor" id="a940a3771e98c08da18307b2309ca7357"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">const <a class="el" href="structcrashpad_1_1CPUContext.html">CPUContext</a> * crashpad::internal::ThreadSnapshotWin::Context </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">override</span><span class="mlabel">virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Returns a <a class="el" href="structcrashpad_1_1CPUContext.html" title="A context structure capable of carrying the context of any supported CPU architecture. ">CPUContext</a> object corresponding to the thread’s CPU context. </p> <p>The caller does not take ownership of this object, it is scoped to the lifetime of the <a class="el" href="classcrashpad_1_1ThreadSnapshot.html" title="An abstract interface to a snapshot representing a thread (lightweight process) present in a snapshot...">ThreadSnapshot</a> object that it was obtained from. </p> <p>Implements <a class="el" href="classcrashpad_1_1ThreadSnapshot.html#a6e227ceaec1f06711d620a99631ec98a">crashpad::ThreadSnapshot</a>.</p> </div> </div> <a class="anchor" id="a00c30606d4e1a7a8f43b4c89b3fc4e8e"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">std::vector< const <a class="el" href="classcrashpad_1_1MemorySnapshot.html">MemorySnapshot</a> * > crashpad::internal::ThreadSnapshotWin::ExtraMemory </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">override</span><span class="mlabel">virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Returns a vector of additional memory blocks that should be included in a minidump. </p> <dl class="section return"><dt>Returns</dt><dd>A vector of <a class="el" href="classcrashpad_1_1MemorySnapshot.html" title="An abstract interface to a snapshot representing a region of memory present in a snapshot process...">MemorySnapshot</a> objects that will be included in the crash dump. The caller does not take ownership of these objects, they are scoped to the lifetime of the <a class="el" href="classcrashpad_1_1ThreadSnapshot.html" title="An abstract interface to a snapshot representing a thread (lightweight process) present in a snapshot...">ThreadSnapshot</a> object that they were obtained from. </dd></dl> <p>Implements <a class="el" href="classcrashpad_1_1ThreadSnapshot.html#a983c5e668ae54cbf8f4348f95da4afc8">crashpad::ThreadSnapshot</a>.</p> </div> </div> <a class="anchor" id="ab480db58d2bc69f82e5db5fef5b3592d"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool crashpad::internal::ThreadSnapshotWin::Initialize </td> <td>(</td> <td class="paramtype"><a class="el" href="classcrashpad_1_1ProcessReaderWin.html">ProcessReaderWin</a> * </td> <td class="paramname"><em>process_reader</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const <a class="el" href="structcrashpad_1_1ProcessReaderWin_1_1Thread.html">ProcessReaderWin::Thread</a> & </td> <td class="paramname"><em>process_reader_thread</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Initializes the object. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramdir">[in]</td><td class="paramname">process_reader</td><td>A <a class="el" href="classcrashpad_1_1ProcessReaderWin.html" title="Accesses information about another process, identified by a HANDLE. ">ProcessReaderWin</a> for the process containing the thread. </td></tr> <tr><td class="paramdir">[in]</td><td class="paramname">process_reader_thread</td><td>The thread within the <a class="el" href="classcrashpad_1_1ProcessReaderWin.html" title="Accesses information about another process, identified by a HANDLE. ">ProcessReaderWin</a> for which the snapshot should be created.</td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd><code>true</code> if the snapshot could be created, <code>false</code> otherwise with an appropriate message logged. </dd></dl> </div> </div> <a class="anchor" id="a84dae6824c9bda4fe6d459ea032dd28a"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">int crashpad::internal::ThreadSnapshotWin::Priority </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">override</span><span class="mlabel">virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Returns the thread’s priority. </p> <p>Threads with higher priorities will have higher priority values. </p> <p>Implements <a class="el" href="classcrashpad_1_1ThreadSnapshot.html#affbf3f8bee03bd703bc2833c4e714f70">crashpad::ThreadSnapshot</a>.</p> </div> </div> <a class="anchor" id="ac069bf4439cbb2be3b243460d7717826"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">const <a class="el" href="classcrashpad_1_1MemorySnapshot.html">MemorySnapshot</a> * crashpad::internal::ThreadSnapshotWin::Stack </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">override</span><span class="mlabel">virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Returns a <a class="el" href="classcrashpad_1_1MemorySnapshot.html" title="An abstract interface to a snapshot representing a region of memory present in a snapshot process...">MemorySnapshot</a> object corresponding to the memory region that contains the thread’s stack, or <code>nullptr</code> if no stack region is available. </p> <p>The caller does not take ownership of this object, it is scoped to the lifetime of the <a class="el" href="classcrashpad_1_1ThreadSnapshot.html" title="An abstract interface to a snapshot representing a thread (lightweight process) present in a snapshot...">ThreadSnapshot</a> object that it was obtained from. </p> <p>Implements <a class="el" href="classcrashpad_1_1ThreadSnapshot.html#a4f0eadc03965ea69a6b0462f878dd628">crashpad::ThreadSnapshot</a>.</p> </div> </div> <a class="anchor" id="ad0f0966f362f6e02f59d3aa436990a15"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">int crashpad::internal::ThreadSnapshotWin::SuspendCount </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">override</span><span class="mlabel">virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Returns the thread’s suspend count. </p> <p>A suspend count of <code>0</code> denotes a schedulable (not suspended) thread. </p> <p>Implements <a class="el" href="classcrashpad_1_1ThreadSnapshot.html#abe00a7e9cbc55366a545700517762d5c">crashpad::ThreadSnapshot</a>.</p> </div> </div> <a class="anchor" id="aaedbdde56b7ba7c6c271758da0fcb1e2"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">uint64_t crashpad::internal::ThreadSnapshotWin::ThreadID </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">override</span><span class="mlabel">virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Returns the thread’s identifier. </p> <p>Thread identifiers are at least unique within a process, and may be unique system-wide. </p> <p>Implements <a class="el" href="classcrashpad_1_1ThreadSnapshot.html#a3c953575fadb934cd5f163560df149da">crashpad::ThreadSnapshot</a>.</p> </div> </div> <hr/>The documentation for this class was generated from the following files:<ul> <li>snapshot/win/thread_snapshot_win.h</li> <li>snapshot/win/thread_snapshot_win.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.9.1 </small></address> </body> </html>