WinStd/classwinstd_1_1event__fn__auto.html

147 lines
11 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.10.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>WinStd: winstd::event_fn_auto 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>
<script type="text/javascript" src="clipboard.js"></script>
<script type="text/javascript" src="cookie.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.10.0 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;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&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(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">
<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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><b>winstd</b></li><li class="navelem"><a class="el" href="classwinstd_1_1event__fn__auto.html">event_fn_auto</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="classwinstd_1_1event__fn__auto-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">winstd::event_fn_auto Class Reference<div class="ingroups"><a class="el" href="group___win_std_e_t_w_a_p_i.html">Event Tracing for Windows API</a></div></div></div>
</div><!--header-->
<div class="contents">
<p>Helper class to write an event on entry/exit of scope.
<a href="#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="_e_t_w_8h_source.html">WinStd/ETW.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a751244aeeeceb01401da27c5080fc590" id="r_a751244aeeeceb01401da27c5080fc590"><td class="memItemLeft" align="right" valign="top"><a id="a751244aeeeceb01401da27c5080fc590" name="a751244aeeeceb01401da27c5080fc590"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>event_fn_auto</b> (<a class="el" href="classwinstd_1_1event__provider.html">event_provider</a> &amp;<a class="el" href="classwinstd_1_1ref__unique__ptr.html">ep</a>, <a class="el" href="classwinstd_1_1ref__unique__ptr.html">const</a> <a class="el" href="classwinstd_1_1ref__unique__ptr.html">EVENT_DESCRIPTOR</a> *<a class="el" href="classwinstd_1_1ref__unique__ptr.html">event_cons</a>, <a class="el" href="classwinstd_1_1ref__unique__ptr.html">const</a> <a class="el" href="classwinstd_1_1ref__unique__ptr.html">EVENT_DESCRIPTOR</a> *<a class="el" href="classwinstd_1_1ref__unique__ptr.html">event_dest</a>, <a class="el" href="classwinstd_1_1ref__unique__ptr.html">LPCSTR</a> <a class="el" href="classwinstd_1_1ref__unique__ptr.html">pszFnName</a>)</td></tr>
<tr class="memdesc:a751244aeeeceb01401da27c5080fc590"><td class="mdescLeft">&#160;</td><td class="mdescRight">Writes the <code>event_cons</code> event. <br /></td></tr>
<tr class="separator:a751244aeeeceb01401da27c5080fc590"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aed0b955ff2db183f6667345925801b0b" id="r_aed0b955ff2db183f6667345925801b0b"><td class="memItemLeft" align="right" valign="top"><a id="aed0b955ff2db183f6667345925801b0b" name="aed0b955ff2db183f6667345925801b0b"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>event_fn_auto</b> (<a class="el" href="classwinstd_1_1ref__unique__ptr.html">const</a> <a class="el" href="classwinstd_1_1event__fn__auto.html">event_fn_auto</a> &amp;other)</td></tr>
<tr class="memdesc:aed0b955ff2db183f6667345925801b0b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copies the object. <br /></td></tr>
<tr class="separator:aed0b955ff2db183f6667345925801b0b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5c45c1de3b87f6547f6e76a80b80f500" id="r_a5c45c1de3b87f6547f6e76a80b80f500"><td class="memItemLeft" align="right" valign="top"><a id="a5c45c1de3b87f6547f6e76a80b80f500" name="a5c45c1de3b87f6547f6e76a80b80f500"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>event_fn_auto</b> (<a class="el" href="classwinstd_1_1event__fn__auto.html">event_fn_auto</a> &amp;&amp;other) <a class="el" href="classwinstd_1_1ref__unique__ptr.html">noexcept</a></td></tr>
<tr class="memdesc:a5c45c1de3b87f6547f6e76a80b80f500"><td class="mdescLeft">&#160;</td><td class="mdescRight">Moves the object. <br /></td></tr>
<tr class="separator:a5c45c1de3b87f6547f6e76a80b80f500"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a764a83cffe2ed2ae41e9d973073d5cb0" id="r_a764a83cffe2ed2ae41e9d973073d5cb0"><td class="memItemLeft" align="right" valign="top"><a id="a764a83cffe2ed2ae41e9d973073d5cb0" name="a764a83cffe2ed2ae41e9d973073d5cb0"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>~event_fn_auto</b> ()</td></tr>
<tr class="memdesc:a764a83cffe2ed2ae41e9d973073d5cb0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Writes the <code>event_dest</code> event. <br /></td></tr>
<tr class="separator:a764a83cffe2ed2ae41e9d973073d5cb0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acb8dddbdd22399d26d4c5db2998afc1d" id="r_acb8dddbdd22399d26d4c5db2998afc1d"><td class="memItemLeft" align="right" valign="top"><a id="acb8dddbdd22399d26d4c5db2998afc1d" name="acb8dddbdd22399d26d4c5db2998afc1d"></a>
<a class="el" href="classwinstd_1_1event__fn__auto.html">event_fn_auto</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>operator=</b> (<a class="el" href="classwinstd_1_1ref__unique__ptr.html">const</a> <a class="el" href="classwinstd_1_1event__fn__auto.html">event_fn_auto</a> &amp;other)</td></tr>
<tr class="memdesc:acb8dddbdd22399d26d4c5db2998afc1d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copies the object. <br /></td></tr>
<tr class="separator:acb8dddbdd22399d26d4c5db2998afc1d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab64dd267c58d816b4ef5549e704a8949" id="r_ab64dd267c58d816b4ef5549e704a8949"><td class="memItemLeft" align="right" valign="top"><a id="ab64dd267c58d816b4ef5549e704a8949" name="ab64dd267c58d816b4ef5549e704a8949"></a>
<a class="el" href="classwinstd_1_1event__fn__auto.html">event_fn_auto</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>operator=</b> (<a class="el" href="classwinstd_1_1event__fn__auto.html">event_fn_auto</a> &amp;&amp;other) <a class="el" href="classwinstd_1_1ref__unique__ptr.html">noexcept</a></td></tr>
<tr class="memdesc:ab64dd267c58d816b4ef5549e704a8949"><td class="mdescLeft">&#160;</td><td class="mdescRight">Moves the object. <br /></td></tr>
<tr class="separator:ab64dd267c58d816b4ef5549e704a8949"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-attribs" name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:acbfdaed91d8a3aa3346d33d1a548457a" id="r_acbfdaed91d8a3aa3346d33d1a548457a"><td class="memItemLeft" align="right" valign="top"><a id="acbfdaed91d8a3aa3346d33d1a548457a" name="acbfdaed91d8a3aa3346d33d1a548457a"></a>
<a class="el" href="classwinstd_1_1event__provider.html">event_provider</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>m_ep</b></td></tr>
<tr class="memdesc:acbfdaed91d8a3aa3346d33d1a548457a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reference to event provider in use. <br /></td></tr>
<tr class="separator:acbfdaed91d8a3aa3346d33d1a548457a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a03080fbd3201b899cce1ab5bb59dca2f" id="r_a03080fbd3201b899cce1ab5bb59dca2f"><td class="memItemLeft" align="right" valign="top"><a id="a03080fbd3201b899cce1ab5bb59dca2f" name="a03080fbd3201b899cce1ab5bb59dca2f"></a>
<a class="el" href="classwinstd_1_1ref__unique__ptr.html">const</a> <a class="el" href="classwinstd_1_1ref__unique__ptr.html">EVENT_DESCRIPTOR</a> *&#160;</td><td class="memItemRight" valign="bottom"><b>m_event_dest</b></td></tr>
<tr class="memdesc:a03080fbd3201b899cce1ab5bb59dca2f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event descriptor at destruction. <br /></td></tr>
<tr class="separator:a03080fbd3201b899cce1ab5bb59dca2f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad17409fc9cdaa8b78a9f38e39e21a9f0" id="r_ad17409fc9cdaa8b78a9f38e39e21a9f0"><td class="memItemLeft" align="right" valign="top"><a id="ad17409fc9cdaa8b78a9f38e39e21a9f0" name="ad17409fc9cdaa8b78a9f38e39e21a9f0"></a>
EVENT_DATA_DESCRIPTOR&#160;</td><td class="memItemRight" valign="bottom"><b>m_fn_name</b></td></tr>
<tr class="memdesc:ad17409fc9cdaa8b78a9f38e39e21a9f0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Function name. <br /></td></tr>
<tr class="separator:ad17409fc9cdaa8b78a9f38e39e21a9f0"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Helper class to write an event on entry/exit of scope. </p>
<p>It writes one string event at creation and another at destruction. </p>
</div><hr/>The documentation for this class was generated from the following file:<ul>
<li>include/WinStd/<a class="el" href="_e_t_w_8h_source.html">ETW.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue Jan 2 2024 11:12:44 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.10.0
</small></address>
</body>
</html>