298 lines
16 KiB
HTML
298 lines
16 KiB
HTML
<!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" lang="en-US">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
|
|
<meta name="generator" content="Doxygen 1.9.8"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>WinStd: Event Tracing for Windows API</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" />
|
|
</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 id="projectrow">
|
|
<td id="projectalign">
|
|
<div id="projectname">WinStd
|
|
</div>
|
|
<div id="projectbrief">Windows Win32 API using Standard C++</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.9.8 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
var searchBox = new SearchBox("searchBox", "search/",'.html');
|
|
/* @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:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
/* @license-end */
|
|
</script>
|
|
<div id="main-nav"></div>
|
|
</div><!-- top -->
|
|
<!-- 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">
|
|
<div id="MSearchResults">
|
|
<div class="SRPage">
|
|
<div id="SRIndex">
|
|
<div id="SRResults"></div>
|
|
<div class="SRStatus" id="Loading">Loading...</div>
|
|
<div class="SRStatus" id="Searching">Searching...</div>
|
|
<div class="SRStatus" id="NoMatches">No Matches</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#nested-classes">Classes</a> |
|
|
<a href="#func-members">Functions</a> |
|
|
<a href="#var-members">Variables</a> </div>
|
|
<div class="headertitle"><div class="title">Event Tracing for Windows API</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
|
|
Classes</h2></td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classwinstd_1_1event__data.html">winstd::event_data</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">EVENT_DATA_DESCRIPTOR wrapper. <a href="classwinstd_1_1event__data.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classwinstd_1_1event__rec.html">winstd::event_rec</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">EVENT_RECORD wrapper. <a href="classwinstd_1_1event__rec.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classwinstd_1_1event__provider.html">winstd::event_provider</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">ETW event provider. <a href="classwinstd_1_1event__provider.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classwinstd_1_1event__session.html">winstd::event_session</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">ETW session. <a href="classwinstd_1_1event__session.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classwinstd_1_1event__trace.html">winstd::event_trace</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">ETW trace. <a href="classwinstd_1_1event__trace.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classwinstd_1_1event__trace__enabler.html">winstd::event_trace_enabler</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Helper class to enable event provider in constructor and disables it in destructor. <a href="classwinstd_1_1event__trace__enabler.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classwinstd_1_1event__fn__auto.html">winstd::event_fn_auto</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Helper class to write an event on entry/exit of scope. <a href="classwinstd_1_1event__fn__auto.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classwinstd_1_1event__fn__auto__ret.html">winstd::event_fn_auto_ret< T ></a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Helper template to write an event on entry/exit of scope with one parameter (typically result). <a href="classwinstd_1_1event__fn__auto__ret.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
|
|
Functions</h2></td></tr>
|
|
<tr class="memitem:ga565b3185a93009edbb2d248227106bec" id="r_ga565b3185a93009edbb2d248227106bec"><td class="memTemplParams" colspan="2">template<class _Ty , class _Ax > </td></tr>
|
|
<tr class="memitem:ga565b3185a93009edbb2d248227106bec"><td class="memTemplItemLeft" align="right" valign="top">static ULONG </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group___win_std_e_t_w_a_p_i.html#ga565b3185a93009edbb2d248227106bec">TdhGetProperty</a> (PEVENT_RECORD pEvent, ULONG TdhContextCount, PTDH_CONTEXT pTdhContext, ULONG PropertyDataCount, PPROPERTY_DATA_DESCRIPTOR pPropertyData, std::vector< _Ty, _Ax > &aData)</td></tr>
|
|
<tr class="memdesc:ga565b3185a93009edbb2d248227106bec"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves a property value from the event data. <br /></td></tr>
|
|
<tr class="separator:ga565b3185a93009edbb2d248227106bec"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga318eb7aaef74aa01c86039520360e68a" id="r_ga318eb7aaef74aa01c86039520360e68a"><td class="memItemLeft" align="right" valign="top">static ULONG </td><td class="memItemRight" valign="bottom"><a class="el" href="group___win_std_e_t_w_a_p_i.html#ga318eb7aaef74aa01c86039520360e68a">TdhGetEventInformation</a> (PEVENT_RECORD pEvent, ULONG TdhContextCount, PTDH_CONTEXT pTdhContext, std::unique_ptr< TRACE_EVENT_INFO > &info)</td></tr>
|
|
<tr class="memdesc:ga318eb7aaef74aa01c86039520360e68a"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves metadata about an event. <br /></td></tr>
|
|
<tr class="separator:ga318eb7aaef74aa01c86039520360e68a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga6726748672bf351a0910292e0ef23290" id="r_ga6726748672bf351a0910292e0ef23290"><td class="memItemLeft" align="right" valign="top">static ULONG </td><td class="memItemRight" valign="bottom"><a class="el" href="group___win_std_e_t_w_a_p_i.html#ga6726748672bf351a0910292e0ef23290">TdhGetEventMapInformation</a> (PEVENT_RECORD pEvent, LPWSTR pMapName, std::unique_ptr< EVENT_MAP_INFO > &info)</td></tr>
|
|
<tr class="memdesc:ga6726748672bf351a0910292e0ef23290"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves information about the event map contained in the event. <br /></td></tr>
|
|
<tr class="separator:ga6726748672bf351a0910292e0ef23290"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="var-members" name="var-members"></a>
|
|
Variables</h2></td></tr>
|
|
<tr class="memitem:gaf7a60dde62523f074610aef107bd5d9d" id="r_gaf7a60dde62523f074610aef107bd5d9d"><td class="memItemLeft" align="right" valign="top"><a id="gaf7a60dde62523f074610aef107bd5d9d" name="gaf7a60dde62523f074610aef107bd5d9d"></a>
|
|
static const <a class="el" href="classwinstd_1_1event__data.html">event_data</a> </td><td class="memItemRight" valign="bottom"><b>winstd::blank_event_data</b></td></tr>
|
|
<tr class="memdesc:gaf7a60dde62523f074610aef107bd5d9d"><td class="mdescLeft"> </td><td class="mdescRight">Blank event data used as terminator. <br /></td></tr>
|
|
<tr class="separator:gaf7a60dde62523f074610aef107bd5d9d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<h2 class="groupheader">Function Documentation</h2>
|
|
<a id="ga318eb7aaef74aa01c86039520360e68a" name="ga318eb7aaef74aa01c86039520360e68a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga318eb7aaef74aa01c86039520360e68a">◆ </a></span>TdhGetEventInformation()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static ULONG TdhGetEventInformation </td>
|
|
<td>(</td>
|
|
<td class="paramtype">PEVENT_RECORD </td>
|
|
<td class="paramname"><em>pEvent</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">ULONG </td>
|
|
<td class="paramname"><em>TdhContextCount</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">PTDH_CONTEXT </td>
|
|
<td class="paramname"><em>pTdhContext</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">std::unique_ptr< TRACE_EVENT_INFO > & </td>
|
|
<td class="paramname"><em>info</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Retrieves metadata about an event. </p>
|
|
<dl class="section see"><dt>See also</dt><dd><a href="https://msdn.microsoft.com/en-us/library/windows/desktop/aa964840.aspx">TdhGetEventInformation function</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga6726748672bf351a0910292e0ef23290" name="ga6726748672bf351a0910292e0ef23290"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga6726748672bf351a0910292e0ef23290">◆ </a></span>TdhGetEventMapInformation()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static ULONG TdhGetEventMapInformation </td>
|
|
<td>(</td>
|
|
<td class="paramtype">PEVENT_RECORD </td>
|
|
<td class="paramname"><em>pEvent</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">LPWSTR </td>
|
|
<td class="paramname"><em>pMapName</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">std::unique_ptr< EVENT_MAP_INFO > & </td>
|
|
<td class="paramname"><em>info</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Retrieves information about the event map contained in the event. </p>
|
|
<dl class="section see"><dt>See also</dt><dd><a href="https://msdn.microsoft.com/en-us/library/windows/desktop/aa964841.aspx">TdhGetEventMapInformation function</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga565b3185a93009edbb2d248227106bec" name="ga565b3185a93009edbb2d248227106bec"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga565b3185a93009edbb2d248227106bec">◆ </a></span>TdhGetProperty()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<class _Ty , class _Ax > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static ULONG TdhGetProperty </td>
|
|
<td>(</td>
|
|
<td class="paramtype">PEVENT_RECORD </td>
|
|
<td class="paramname"><em>pEvent</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">ULONG </td>
|
|
<td class="paramname"><em>TdhContextCount</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">PTDH_CONTEXT </td>
|
|
<td class="paramname"><em>pTdhContext</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">ULONG </td>
|
|
<td class="paramname"><em>PropertyDataCount</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">PPROPERTY_DATA_DESCRIPTOR </td>
|
|
<td class="paramname"><em>pPropertyData</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">std::vector< _Ty, _Ax > & </td>
|
|
<td class="paramname"><em>aData</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Retrieves a property value from the event data. </p>
|
|
<dl class="section see"><dt>See also</dt><dd><a href="https://msdn.microsoft.com/en-us/library/windows/desktop/aa964843.aspx">TdhGetProperty function</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated on Wed Oct 18 2023 10:37:20 for WinStd by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
|
|
</small></address>
|
|
</body>
|
|
</html>
|