WinStd/group___win_std_sys_handles.html

189 lines
12 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: System Handles</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>
</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> &#124;
<a href="#define-members">Macros</a> &#124;
<a href="#var-members">Variables</a> </div>
<div class="headertitle"><div class="title">System Handles</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 &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwinstd_1_1handle.html">winstd::handle&lt; T, INVAL &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Base abstract template class to support generic object handle keeping. <a href="classwinstd_1_1handle.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_1dplhandle.html">winstd::dplhandle&lt; T, INVAL &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Base abstract template class to support object handle keeping for objects that support trivial handle duplication. <a href="classwinstd_1_1dplhandle.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="define-members" name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ga51471bfe41853b66ac0f44df97cfaaa6" id="r_ga51471bfe41853b66ac0f44df97cfaaa6"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ga51471bfe41853b66ac0f44df97cfaaa6">WINSTD_HANDLE_IMPL</a>(C, T, INVAL)</td></tr>
<tr class="memdesc:ga51471bfe41853b66ac0f44df97cfaaa6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Implements default constructors and operators to prevent their auto-generation by compiler. <br /></td></tr>
<tr class="separator:ga51471bfe41853b66ac0f44df97cfaaa6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga08a7da8215842be9aaacae90bc8a1b62" id="r_ga08a7da8215842be9aaacae90bc8a1b62"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ga08a7da8215842be9aaacae90bc8a1b62">WINSTD_DPLHANDLE_IMPL</a>(C, T, INVAL)</td></tr>
<tr class="memdesc:ga08a7da8215842be9aaacae90bc8a1b62"><td class="mdescLeft">&#160;</td><td class="mdescRight">Implements default constructors and operators to prevent their auto-generation by compiler. <br /></td></tr>
<tr class="separator:ga08a7da8215842be9aaacae90bc8a1b62"><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:gacf43e306968474166474090690857e1c" id="r_gacf43e306968474166474090690857e1c"><td class="memItemLeft" align="right" valign="top"><a id="gacf43e306968474166474090690857e1c" name="gacf43e306968474166474090690857e1c"></a>
<a class="el" href="classwinstd_1_1ref__unique__ptr.html">static</a> <a class="el" href="classwinstd_1_1ref__unique__ptr.html">const</a> <a class="el" href="classwinstd_1_1ref__unique__ptr.html">T</a>&#160;</td><td class="memItemRight" valign="bottom"><b>winstd::handle&lt; T, INVAL &gt;::invalid</b> = <a class="el" href="classwinstd_1_1ref__unique__ptr.html">INVAL</a></td></tr>
<tr class="memdesc:gacf43e306968474166474090690857e1c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Invalid handle value. <br /></td></tr>
<tr class="separator:gacf43e306968474166474090690857e1c"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a id="ga08a7da8215842be9aaacae90bc8a1b62" name="ga08a7da8215842be9aaacae90bc8a1b62"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga08a7da8215842be9aaacae90bc8a1b62">&#9670;&#160;</a></span>WINSTD_DPLHANDLE_IMPL</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define WINSTD_DPLHANDLE_IMPL</td>
<td>(</td>
<td class="paramtype"></td> <td class="paramname"><span class="paramname">C, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"></td> <td class="paramname"><span class="paramname">T, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"></td> <td class="paramname"><span class="paramname">INVAL</span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line"><span class="keyword">public</span>: \</div>
<div class="line"> C ( ) noexcept {} \</div>
<div class="line"> C (_In_opt_ T h) noexcept : dplhandle&lt;T, INVAL&gt;( h ) {} \</div>
<div class="line"> C (_In_ <span class="keyword">const</span> C &amp;h) noexcept : dplhandle&lt;T, INVAL&gt;(duplicate_internal(h.m_h)) {} \</div>
<div class="line"> C (_Inout_ C &amp;&amp;h) noexcept : dplhandle&lt;T, INVAL&gt;(std::move (h )) {} \</div>
<div class="line"> C&amp; operator=(_In_opt_ T h) <span class="keyword">noexcept</span> { dplhandle&lt;T, INVAL&gt;::operator=( h ); <span class="keywordflow">return</span> *<span class="keyword">this</span>; } \</div>
<div class="line"> C&amp; operator=(_In_ <span class="keyword">const</span> C &amp;h) <span class="keyword">noexcept</span> { dplhandle&lt;T, INVAL&gt;::operator=( h ); <span class="keywordflow">return</span> *<span class="keyword">this</span>; } \</div>
<div class="line"> C&amp; operator=(_Inout_ C &amp;&amp;h) <span class="keyword">noexcept</span> { dplhandle&lt;T, INVAL&gt;::operator=(std::move(h)); <span class="keywordflow">return</span> *<span class="keyword">this</span>; } \</div>
<div class="line"><span class="keyword">private</span>:</div>
</div><!-- fragment -->
<p>Implements default constructors and operators to prevent their auto-generation by compiler. </p>
</div>
</div>
<a id="ga51471bfe41853b66ac0f44df97cfaaa6" name="ga51471bfe41853b66ac0f44df97cfaaa6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga51471bfe41853b66ac0f44df97cfaaa6">&#9670;&#160;</a></span>WINSTD_HANDLE_IMPL</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define WINSTD_HANDLE_IMPL</td>
<td>(</td>
<td class="paramtype"></td> <td class="paramname"><span class="paramname">C, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"></td> <td class="paramname"><span class="paramname">T, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"></td> <td class="paramname"><span class="paramname">INVAL</span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line"><span class="keyword">public</span>: \</div>
<div class="line"> C ( ) noexcept {} \</div>
<div class="line"> C (_In_opt_ T h) noexcept : handle&lt;T, INVAL&gt;( h ) {} \</div>
<div class="line"> C (_Inout_ C &amp;&amp;h) noexcept : handle&lt;T, INVAL&gt;(std::move(h)) {} \</div>
<div class="line"> C&amp; operator=(_In_opt_ T h) <span class="keyword">noexcept</span> { handle&lt;T, INVAL&gt;::operator=( h ); <span class="keywordflow">return</span> *<span class="keyword">this</span>; } \</div>
<div class="line"> C&amp; operator=(_Inout_ C &amp;&amp;h) <span class="keyword">noexcept</span> { handle&lt;T, INVAL&gt;::operator=(std::move(h)); <span class="keywordflow">return</span> *<span class="keyword">this</span>; } \</div>
<div class="line">WINSTD_NONCOPYABLE(C)</div>
</div><!-- fragment -->
<p>Implements default constructors and operators to prevent their auto-generation by compiler. </p>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue Jan 16 2024 15:12:05 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>