WinStd/classwinstd_1_1event__fn__auto__ret.html

152 lines
13 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_ret&lt; T &gt; Class Template 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__ret.html">event_fn_auto_ret</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__ret-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">winstd::event_fn_auto_ret&lt; T &gt; Class Template 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 template to write an event on entry/exit of scope with one parameter (typically result).
<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:a52fe971a33082d3652dd6d99378f17c5" id="r_a52fe971a33082d3652dd6d99378f17c5"><td class="memItemLeft" align="right" valign="top"><a id="a52fe971a33082d3652dd6d99378f17c5" name="a52fe971a33082d3652dd6d99378f17c5"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>event_fn_auto_ret</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>, <a class="el" href="classwinstd_1_1ref__unique__ptr.html">T</a> &amp;<a class="el" href="classwinstd_1_1ref__unique__ptr.html">result</a>)</td></tr>
<tr class="memdesc:a52fe971a33082d3652dd6d99378f17c5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Writes the <code>event_cons</code> event. <br /></td></tr>
<tr class="separator:a52fe971a33082d3652dd6d99378f17c5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0f656d3899f65afdaee9c651baf69bff" id="r_a0f656d3899f65afdaee9c651baf69bff"><td class="memItemLeft" align="right" valign="top"><a id="a0f656d3899f65afdaee9c651baf69bff" name="a0f656d3899f65afdaee9c651baf69bff"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>event_fn_auto_ret</b> (<a class="el" href="classwinstd_1_1ref__unique__ptr.html">const</a> <a class="el" href="classwinstd_1_1event__fn__auto__ret.html">event_fn_auto_ret</a>&lt; <a class="el" href="classwinstd_1_1ref__unique__ptr.html">T</a> &gt; &amp;other)</td></tr>
<tr class="memdesc:a0f656d3899f65afdaee9c651baf69bff"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copies the object. <br /></td></tr>
<tr class="separator:a0f656d3899f65afdaee9c651baf69bff"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac8b93b2bb498280707f795c03024d7d3" id="r_ac8b93b2bb498280707f795c03024d7d3"><td class="memItemLeft" align="right" valign="top"><a id="ac8b93b2bb498280707f795c03024d7d3" name="ac8b93b2bb498280707f795c03024d7d3"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>event_fn_auto_ret</b> (<a class="el" href="classwinstd_1_1event__fn__auto__ret.html">event_fn_auto_ret</a>&lt; <a class="el" href="classwinstd_1_1ref__unique__ptr.html">T</a> &gt; &amp;&amp;other)</td></tr>
<tr class="memdesc:ac8b93b2bb498280707f795c03024d7d3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Moves the object. <br /></td></tr>
<tr class="separator:ac8b93b2bb498280707f795c03024d7d3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1bd1de5df10856a08187ad112992979f" id="r_a1bd1de5df10856a08187ad112992979f"><td class="memItemLeft" align="right" valign="top"><a id="a1bd1de5df10856a08187ad112992979f" name="a1bd1de5df10856a08187ad112992979f"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>~event_fn_auto_ret</b> ()</td></tr>
<tr class="memdesc:a1bd1de5df10856a08187ad112992979f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Writes the <code>event_dest</code> event. <br /></td></tr>
<tr class="separator:a1bd1de5df10856a08187ad112992979f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6bb69bf1ac97231ef47c2aed99921bc9" id="r_a6bb69bf1ac97231ef47c2aed99921bc9"><td class="memItemLeft" align="right" valign="top"><a id="a6bb69bf1ac97231ef47c2aed99921bc9" name="a6bb69bf1ac97231ef47c2aed99921bc9"></a>
<a class="el" href="classwinstd_1_1event__fn__auto__ret.html">event_fn_auto_ret</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__ret.html">event_fn_auto_ret</a>&lt; <a class="el" href="classwinstd_1_1ref__unique__ptr.html">T</a> &gt; &amp;other)</td></tr>
<tr class="memdesc:a6bb69bf1ac97231ef47c2aed99921bc9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copies the object. <br /></td></tr>
<tr class="separator:a6bb69bf1ac97231ef47c2aed99921bc9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ade4fd767e5e743649480b93cd0a5ba69" id="r_ade4fd767e5e743649480b93cd0a5ba69"><td class="memItemLeft" align="right" valign="top"><a id="ade4fd767e5e743649480b93cd0a5ba69" name="ade4fd767e5e743649480b93cd0a5ba69"></a>
<a class="el" href="classwinstd_1_1event__fn__auto__ret.html">event_fn_auto_ret</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>operator=</b> (<a class="el" href="classwinstd_1_1event__fn__auto__ret.html">event_fn_auto_ret</a>&lt; <a class="el" href="classwinstd_1_1ref__unique__ptr.html">T</a> &gt; &amp;&amp;other)</td></tr>
<tr class="memdesc:ade4fd767e5e743649480b93cd0a5ba69"><td class="mdescLeft">&#160;</td><td class="mdescRight">Moves the object. <br /></td></tr>
<tr class="separator:ade4fd767e5e743649480b93cd0a5ba69"><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:a52a16bf54fa9fc800e7c18d3fd75fb53" id="r_a52a16bf54fa9fc800e7c18d3fd75fb53"><td class="memItemLeft" align="right" valign="top"><a id="a52a16bf54fa9fc800e7c18d3fd75fb53" name="a52a16bf54fa9fc800e7c18d3fd75fb53"></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:a52a16bf54fa9fc800e7c18d3fd75fb53"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reference to event provider in use. <br /></td></tr>
<tr class="separator:a52a16bf54fa9fc800e7c18d3fd75fb53"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8d168be3f57047c78fa329ff3eb2e700" id="r_a8d168be3f57047c78fa329ff3eb2e700"><td class="memItemLeft" align="right" valign="top"><a id="a8d168be3f57047c78fa329ff3eb2e700" name="a8d168be3f57047c78fa329ff3eb2e700"></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:a8d168be3f57047c78fa329ff3eb2e700"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event descriptor at destruction. <br /></td></tr>
<tr class="separator:a8d168be3f57047c78fa329ff3eb2e700"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a23fa88c6a7aea86536cc0e4bee2746cf" id="r_a23fa88c6a7aea86536cc0e4bee2746cf"><td class="memItemLeft" align="right" valign="top"><a id="a23fa88c6a7aea86536cc0e4bee2746cf" name="a23fa88c6a7aea86536cc0e4bee2746cf"></a>
EVENT_DATA_DESCRIPTOR&#160;</td><td class="memItemRight" valign="bottom"><b>m_desc</b> [2]</td></tr>
<tr class="memdesc:a23fa88c6a7aea86536cc0e4bee2746cf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Function name and return value. <br /></td></tr>
<tr class="separator:a23fa88c6a7aea86536cc0e4bee2746cf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a69f1ae5c23f90aaa4da012b1eb0b8f81" id="r_a69f1ae5c23f90aaa4da012b1eb0b8f81"><td class="memItemLeft" align="right" valign="top"><a id="a69f1ae5c23f90aaa4da012b1eb0b8f81" name="a69f1ae5c23f90aaa4da012b1eb0b8f81"></a>
<a class="el" href="classwinstd_1_1ref__unique__ptr.html">T</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>m_result</b></td></tr>
<tr class="memdesc:a69f1ae5c23f90aaa4da012b1eb0b8f81"><td class="mdescLeft">&#160;</td><td class="mdescRight">Function result. <br /></td></tr>
<tr class="separator:a69f1ae5c23f90aaa4da012b1eb0b8f81"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><div class="compoundTemplParams">template&lt;<a class="el" href="classwinstd_1_1ref__unique__ptr.html">class</a> <a class="el" href="classwinstd_1_1ref__unique__ptr.html">T</a>&gt;<br />
class winstd::event_fn_auto_ret&lt; T &gt;</div><p>Helper template to write an event on entry/exit of scope with one parameter (typically result). </p>
<p>It writes one string event at creation and another at destruction, with allowing one sprintf type parameter for string event 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 Mon Jan 8 2024 07:53:19 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>