Amebis/WinStd
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
WinStd/group___win_std_e_t_w_a_p_i.html

181 lines
14 KiB
HTML
Raw Blame History

<!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=11"/>
<meta name="generator" content="Doxygen 1.9.3"/>
<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">Additional templates and function helpers for Microsoft Windows using Standard C++ classes</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.3 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'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&amp;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">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#func-members">Functions</a> &#124;
<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">
<p>Integrates WinStd classes with Event Tracing for Windows API.
<a href="#details">More...</a></p>
<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 &#160;</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">&#160;</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">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</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">&#160;</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">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</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">&#160;</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">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</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">&#160;</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">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</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">&#160;</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">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</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">&#160;</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">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</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">&#160;</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">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwinstd_1_1event__fn__auto__ret.html">winstd::event_fn_auto_ret&lt; T &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</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">&#160;</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:ga357aa48f94aa23fb4adcb46dba4bc5c0"><td class="memItemLeft" align="right" valign="top"><a id="ga357aa48f94aa23fb4adcb46dba4bc5c0" name="ga357aa48f94aa23fb4adcb46dba4bc5c0"></a>
static _In_ ULONG&#160;</td><td class="memItemRight" valign="bottom"><b>_In_reads_opt_</b> (TdhContextCount) PTDH_CONTEXT pTdhContext</td></tr>
<tr class="separator:ga357aa48f94aa23fb4adcb46dba4bc5c0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga7dec0e34f6972125098307a3b20aa762"><td class="memItemLeft" align="right" valign="top"><a id="ga7dec0e34f6972125098307a3b20aa762" name="ga7dec0e34f6972125098307a3b20aa762"></a>
static _In_ ULONG _In_ ULONG&#160;</td><td class="memItemRight" valign="bottom"><b>_In_reads_</b> (PropertyDataCount) PPROPERTY_DATA_DESCRIPTOR pPropertyData</td></tr>
<tr class="separator:ga7dec0e34f6972125098307a3b20aa762"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2286b160737b159e9bd9d2f90ecd56af"><td class="memItemLeft" align="right" valign="top"><a id="ga2286b160737b159e9bd9d2f90ecd56af" name="ga2286b160737b159e9bd9d2f90ecd56af"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>if</b> (ulResult==ERROR_SUCCESS)</td></tr>
<tr class="separator:ga2286b160737b159e9bd9d2f90ecd56af"><td class="memSeparator" colspan="2">&#160;</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:gab87506bb3cd80875e4c6655f17dc4c5f"><td class="memItemLeft" align="right" valign="top"><a id="gab87506bb3cd80875e4c6655f17dc4c5f" name="gab87506bb3cd80875e4c6655f17dc4c5f"></a>
static _In_ ULONG&#160;</td><td class="memItemRight" valign="bottom"><b>TdhContextCount</b></td></tr>
<tr class="separator:gab87506bb3cd80875e4c6655f17dc4c5f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gab44fe81095f3cacb809893a7357f8017"><td class="memItemLeft" align="right" valign="top"><a id="gab44fe81095f3cacb809893a7357f8017" name="gab44fe81095f3cacb809893a7357f8017"></a>
static _In_ ULONG _In_ ULONG&#160;</td><td class="memItemRight" valign="bottom"><b>PropertyDataCount</b></td></tr>
<tr class="separator:gab44fe81095f3cacb809893a7357f8017"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2b5f50419b676cc185be4618c010f1f4"><td class="memItemLeft" align="right" valign="top">static _In_ ULONG _In_ ULONG _Inout_ std::vector&lt; _Ty, _Ax &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___win_std_e_t_w_a_p_i.html#ga2b5f50419b676cc185be4618c010f1f4">aData</a></td></tr>
<tr class="separator:ga2b5f50419b676cc185be4618c010f1f4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga08588e5471f4eb3dd22743bb911c9f61"><td class="memItemLeft" align="right" valign="top"><a id="ga08588e5471f4eb3dd22743bb911c9f61" name="ga08588e5471f4eb3dd22743bb911c9f61"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>ulResult</b> = TdhGetPropertySize(pEvent, TdhContextCount, pTdhContext, PropertyDataCount, pPropertyData, &amp;ulSize)</td></tr>
<tr class="separator:ga08588e5471f4eb3dd22743bb911c9f61"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga3f6fc386cc6e0cab9699f9848e240135"><td class="memItemLeft" align="right" valign="top">static _In_ ULONG _Out_ std::unique_ptr&lt; TRACE_EVENT_INFO &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___win_std_e_t_w_a_p_i.html#ga3f6fc386cc6e0cab9699f9848e240135">info</a></td></tr>
<tr class="separator:ga3f6fc386cc6e0cab9699f9848e240135"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga159128f55ab0cbe439e5ad5c57c9319b"><td class="memItemLeft" align="right" valign="top"><a id="ga159128f55ab0cbe439e5ad5c57c9319b" name="ga159128f55ab0cbe439e5ad5c57c9319b"></a>
ULONG&#160;</td><td class="memItemRight" valign="bottom"><b>ulSize</b> = sizeof(szBuffer)</td></tr>
<tr class="separator:ga159128f55ab0cbe439e5ad5c57c9319b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4505f6d81bec41b052fdc94a84ada602"><td class="memItemLeft" align="right" valign="top"><a id="ga4505f6d81bec41b052fdc94a84ada602" name="ga4505f6d81bec41b052fdc94a84ada602"></a>
static _In_ LPWSTR&#160;</td><td class="memItemRight" valign="bottom"><b>pMapName</b></td></tr>
<tr class="separator:ga4505f6d81bec41b052fdc94a84ada602"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p >Integrates WinStd classes with Event Tracing for Windows API. </p>
<h2 class="groupheader">Variable Documentation</h2>
<a id="ga2b5f50419b676cc185be4618c010f1f4" name="ga2b5f50419b676cc185be4618c010f1f4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga2b5f50419b676cc185be4618c010f1f4">&#9670;&nbsp;</a></span>aData</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">_In_ ULONG _In_ ULONG _Inout_ std::vector&lt;_Ty, _Ax&gt;&amp; aData</td>
</tr>
</table>
</div><div class="memdoc">
<b>Initial value:</b><div class="fragment"><div class="line">{</div>
<div class="line"> ULONG ulSize, ulResult</div>
</div><!-- fragment -->
</div>
</div>
<a id="ga3f6fc386cc6e0cab9699f9848e240135" name="ga3f6fc386cc6e0cab9699f9848e240135"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga3f6fc386cc6e0cab9699f9848e240135">&#9670;&nbsp;</a></span>info</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static _In_ LPWSTR _Inout_ std::unique_ptr&lt; EVENT_MAP_INFO &gt; &amp; info</td>
</tr>
</table>
</div><div class="memdoc">
<b>Initial value:</b><div class="fragment"><div class="line">{</div>
<div class="line"> BYTE szBuffer[<a class="code hl_define" href="group___win_std_general.html#ga3ca39107a61bbcd05f901898ec584986">WINSTD_STACK_BUFFER_BYTES</a>]</div>
<div class="ttc" id="agroup___win_std_general_html_ga3ca39107a61bbcd05f901898ec584986"><div class="ttname"><a href="group___win_std_general.html#ga3ca39107a61bbcd05f901898ec584986">WINSTD_STACK_BUFFER_BYTES</a></div><div class="ttdeci">#define WINSTD_STACK_BUFFER_BYTES</div><div class="ttdoc">Size of the stack buffer in bytes used for initial system function call.</div><div class="ttdef"><b>Definition:</b> Common.h:80</div></div>
</div><!-- fragment -->
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Feb 4 2022 12:23:56 for WinStd by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.3
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink