857 lines
50 KiB
HTML
857 lines
50 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.5"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>WinStd: winstd::handle< T, INVAL > 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>
|
|
<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.5 -->
|
|
<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>
|
|
<!-- 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_1handle.html">handle</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-types">Public Types</a> |
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="#pub-static-attribs">Static Public Attributes</a> |
|
|
<a href="#pro-methods">Protected Member Functions</a> |
|
|
<a href="#pro-attribs">Protected Attributes</a> |
|
|
<a href="classwinstd_1_1handle-members.html">List of all members</a> </div>
|
|
<div class="headertitle"><div class="title">winstd::handle< T, INVAL > Class Template Reference<span class="mlabels"><span class="mlabel">abstract</span></span><div class="ingroups"><a class="el" href="group___win_std_sys_handles.html">System Handles</a></div></div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Base abstract template class to support generic object handle keeping.
|
|
<a href="classwinstd_1_1handle.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="_common_8h_source.html">WinStd/Common.h</a>></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for winstd::handle< T, INVAL >:</div>
|
|
<div class="dyncontent">
|
|
<div class="center">
|
|
<img src="classwinstd_1_1handle.png" usemap="#winstd::handle_3C_20T_2C_20INVAL_20_3E_map" alt=""/>
|
|
<map id="winstd::handle_3C_20T_2C_20INVAL_20_3E_map" name="winstd::handle_3C_20T_2C_20INVAL_20_3E_map">
|
|
<area href="classwinstd_1_1dplhandle.html" alt="winstd::dplhandle< BSTR, NULL >" shape="rect" coords="343,56,676,80"/>
|
|
<area href="classwinstd_1_1dplhandle.html" alt="winstd::dplhandle< PCCERT_CHAIN_CONTEXT, NULL >" shape="rect" coords="343,112,676,136"/>
|
|
<area href="classwinstd_1_1dplhandle.html" alt="winstd::dplhandle< PCCERT_CONTEXT, NULL >" shape="rect" coords="343,168,676,192"/>
|
|
<area href="classwinstd_1_1dplhandle.html" alt="winstd::dplhandle< T *, NULL >" shape="rect" coords="343,224,676,248"/>
|
|
<area href="classwinstd_1_1dplhandle.html" alt="winstd::dplhandle< HCRYPTHASH, NULL >" shape="rect" coords="343,280,676,304"/>
|
|
<area href="classwinstd_1_1dplhandle.html" alt="winstd::dplhandle< HCRYPTKEY, NULL >" shape="rect" coords="343,336,676,360"/>
|
|
<area href="classwinstd_1_1dplhandle.html" alt="winstd::dplhandle< EapPacket *, NULL >" shape="rect" coords="343,392,676,416"/>
|
|
<area href="classwinstd_1_1dplhandle.html" title="Base abstract template class to support object handle keeping for objects that support trivial handle..." alt="winstd::dplhandle< T, INVAL >" shape="rect" coords="343,448,676,472"/>
|
|
</map>
|
|
</div></div>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-types" name="pub-types"></a>
|
|
Public Types</h2></td></tr>
|
|
<tr class="memitem:a3dda19199ecfbc378c932e7d84d0ea81"><td class="memItemLeft" align="right" valign="top"><a id="a3dda19199ecfbc378c932e7d84d0ea81" name="a3dda19199ecfbc378c932e7d84d0ea81"></a>
|
|
typedef T </td><td class="memItemRight" valign="bottom"><b>handle_type</b></td></tr>
|
|
<tr class="memdesc:a3dda19199ecfbc378c932e7d84d0ea81"><td class="mdescLeft"> </td><td class="mdescRight">Datatype of the object handle this template class handles. <br /></td></tr>
|
|
<tr class="separator:a3dda19199ecfbc378c932e7d84d0ea81"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><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:a1b9c4f9529c9efa7d16dec8bab3b00e4"><td class="memItemLeft" align="right" valign="top"><a id="a1b9c4f9529c9efa7d16dec8bab3b00e4" name="a1b9c4f9529c9efa7d16dec8bab3b00e4"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>handle</b> () noexcept</td></tr>
|
|
<tr class="memdesc:a1b9c4f9529c9efa7d16dec8bab3b00e4"><td class="mdescLeft"> </td><td class="mdescRight">Initializes a new class instance with the object handle set to INVAL. <br /></td></tr>
|
|
<tr class="separator:a1b9c4f9529c9efa7d16dec8bab3b00e4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4a0f9b6caadf4a55c7bc0dcc0ce39dac"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classwinstd_1_1handle.html#a4a0f9b6caadf4a55c7bc0dcc0ce39dac">handle</a> (<a class="el" href="classwinstd_1_1handle.html#a3dda19199ecfbc378c932e7d84d0ea81">handle_type</a> h) noexcept</td></tr>
|
|
<tr class="memdesc:a4a0f9b6caadf4a55c7bc0dcc0ce39dac"><td class="mdescLeft"> </td><td class="mdescRight">Initializes a new class instance with an already available object handle. <a href="classwinstd_1_1handle.html#a4a0f9b6caadf4a55c7bc0dcc0ce39dac">More...</a><br /></td></tr>
|
|
<tr class="separator:a4a0f9b6caadf4a55c7bc0dcc0ce39dac"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac52f342530bb97ce1ff255a7054547d5"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classwinstd_1_1handle.html#ac52f342530bb97ce1ff255a7054547d5">handle</a> (<a class="el" href="classwinstd_1_1handle.html">handle</a>< <a class="el" href="classwinstd_1_1handle.html#a3dda19199ecfbc378c932e7d84d0ea81">handle_type</a>, INVAL > &&h) noexcept</td></tr>
|
|
<tr class="memdesc:ac52f342530bb97ce1ff255a7054547d5"><td class="mdescLeft"> </td><td class="mdescRight">Move constructor. <a href="classwinstd_1_1handle.html#ac52f342530bb97ce1ff255a7054547d5">More...</a><br /></td></tr>
|
|
<tr class="separator:ac52f342530bb97ce1ff255a7054547d5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a591e006af92e4d088fb9c1ed974c0923"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classwinstd_1_1handle.html">handle</a>< <a class="el" href="classwinstd_1_1handle.html#a3dda19199ecfbc378c932e7d84d0ea81">handle_type</a>, INVAL > & </td><td class="memItemRight" valign="bottom"><a class="el" href="classwinstd_1_1handle.html#a591e006af92e4d088fb9c1ed974c0923">operator=</a> (<a class="el" href="classwinstd_1_1handle.html#a3dda19199ecfbc378c932e7d84d0ea81">handle_type</a> h) noexcept</td></tr>
|
|
<tr class="memdesc:a591e006af92e4d088fb9c1ed974c0923"><td class="mdescLeft"> </td><td class="mdescRight">Attaches already available object handle. <a href="classwinstd_1_1handle.html#a591e006af92e4d088fb9c1ed974c0923">More...</a><br /></td></tr>
|
|
<tr class="separator:a591e006af92e4d088fb9c1ed974c0923"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6326bbc54ec3441e41f30bc1ec4d6a6c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classwinstd_1_1handle.html">handle</a>< <a class="el" href="classwinstd_1_1handle.html#a3dda19199ecfbc378c932e7d84d0ea81">handle_type</a>, INVAL > & </td><td class="memItemRight" valign="bottom"><a class="el" href="classwinstd_1_1handle.html#a6326bbc54ec3441e41f30bc1ec4d6a6c">operator=</a> (<a class="el" href="classwinstd_1_1handle.html">handle</a>< <a class="el" href="classwinstd_1_1handle.html#a3dda19199ecfbc378c932e7d84d0ea81">handle_type</a>, INVAL > &&h) noexcept</td></tr>
|
|
<tr class="memdesc:a6326bbc54ec3441e41f30bc1ec4d6a6c"><td class="mdescLeft"> </td><td class="mdescRight">Move assignment. <a href="classwinstd_1_1handle.html#a6326bbc54ec3441e41f30bc1ec4d6a6c">More...</a><br /></td></tr>
|
|
<tr class="separator:a6326bbc54ec3441e41f30bc1ec4d6a6c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a86114637674c82d6fd96d7b3eae39ac8"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classwinstd_1_1handle.html#a86114637674c82d6fd96d7b3eae39ac8">operator handle_type</a> () const</td></tr>
|
|
<tr class="memdesc:a86114637674c82d6fd96d7b3eae39ac8"><td class="mdescLeft"> </td><td class="mdescRight">Auto-typecasting operator. <a href="classwinstd_1_1handle.html#a86114637674c82d6fd96d7b3eae39ac8">More...</a><br /></td></tr>
|
|
<tr class="separator:a86114637674c82d6fd96d7b3eae39ac8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0f1ac60cf62e41c24394bf0e3457fbd9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classwinstd_1_1handle.html#a3dda19199ecfbc378c932e7d84d0ea81">handle_type</a> *& </td><td class="memItemRight" valign="bottom"><a class="el" href="classwinstd_1_1handle.html#a0f1ac60cf62e41c24394bf0e3457fbd9">operator*</a> () const</td></tr>
|
|
<tr class="memdesc:a0f1ac60cf62e41c24394bf0e3457fbd9"><td class="mdescLeft"> </td><td class="mdescRight">Returns the object handle value when the object handle is a pointer to a value (class, struct, etc.). <a href="classwinstd_1_1handle.html#a0f1ac60cf62e41c24394bf0e3457fbd9">More...</a><br /></td></tr>
|
|
<tr class="separator:a0f1ac60cf62e41c24394bf0e3457fbd9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2bd2de7bb89dcebe2c9379dd54ee79c1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classwinstd_1_1handle.html#a3dda19199ecfbc378c932e7d84d0ea81">handle_type</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classwinstd_1_1handle.html#a2bd2de7bb89dcebe2c9379dd54ee79c1">operator&</a> ()</td></tr>
|
|
<tr class="memdesc:a2bd2de7bb89dcebe2c9379dd54ee79c1"><td class="mdescLeft"> </td><td class="mdescRight">Returns the object handle reference. <a href="classwinstd_1_1handle.html#a2bd2de7bb89dcebe2c9379dd54ee79c1">More...</a><br /></td></tr>
|
|
<tr class="separator:a2bd2de7bb89dcebe2c9379dd54ee79c1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a285ada5936fe7afdd12eed70b38c2084"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classwinstd_1_1handle.html#a3dda19199ecfbc378c932e7d84d0ea81">handle_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classwinstd_1_1handle.html#a285ada5936fe7afdd12eed70b38c2084">operator-></a> () const</td></tr>
|
|
<tr class="memdesc:a285ada5936fe7afdd12eed70b38c2084"><td class="mdescLeft"> </td><td class="mdescRight">Provides object handle member access when the object handle is a pointer to a class or struct. <a href="classwinstd_1_1handle.html#a285ada5936fe7afdd12eed70b38c2084">More...</a><br /></td></tr>
|
|
<tr class="separator:a285ada5936fe7afdd12eed70b38c2084"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5df08ecb32b9040bf7342479aee2286c"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classwinstd_1_1handle.html#a5df08ecb32b9040bf7342479aee2286c">operator!</a> () const</td></tr>
|
|
<tr class="memdesc:a5df08ecb32b9040bf7342479aee2286c"><td class="mdescLeft"> </td><td class="mdescRight">Tests if the object handle is invalid. <a href="classwinstd_1_1handle.html#a5df08ecb32b9040bf7342479aee2286c">More...</a><br /></td></tr>
|
|
<tr class="separator:a5df08ecb32b9040bf7342479aee2286c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4c4515d0d1071cab5c675e926aa2dc92"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classwinstd_1_1handle.html#a4c4515d0d1071cab5c675e926aa2dc92">operator<</a> (<a class="el" href="classwinstd_1_1handle.html#a3dda19199ecfbc378c932e7d84d0ea81">handle_type</a> h) const</td></tr>
|
|
<tr class="memdesc:a4c4515d0d1071cab5c675e926aa2dc92"><td class="mdescLeft"> </td><td class="mdescRight">Is handle less than? <a href="classwinstd_1_1handle.html#a4c4515d0d1071cab5c675e926aa2dc92">More...</a><br /></td></tr>
|
|
<tr class="separator:a4c4515d0d1071cab5c675e926aa2dc92"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af9e9538d58b952799db4a1c68b0184b9"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classwinstd_1_1handle.html#af9e9538d58b952799db4a1c68b0184b9">operator<=</a> (<a class="el" href="classwinstd_1_1handle.html#a3dda19199ecfbc378c932e7d84d0ea81">handle_type</a> h) const</td></tr>
|
|
<tr class="memdesc:af9e9538d58b952799db4a1c68b0184b9"><td class="mdescLeft"> </td><td class="mdescRight">Is handle less than or equal to? <a href="classwinstd_1_1handle.html#af9e9538d58b952799db4a1c68b0184b9">More...</a><br /></td></tr>
|
|
<tr class="separator:af9e9538d58b952799db4a1c68b0184b9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a20e325dde8a25d1e3a7efb50b431641b"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classwinstd_1_1handle.html#a20e325dde8a25d1e3a7efb50b431641b">operator>=</a> (<a class="el" href="classwinstd_1_1handle.html#a3dda19199ecfbc378c932e7d84d0ea81">handle_type</a> h) const</td></tr>
|
|
<tr class="memdesc:a20e325dde8a25d1e3a7efb50b431641b"><td class="mdescLeft"> </td><td class="mdescRight">Is handle greater than or equal to? <a href="classwinstd_1_1handle.html#a20e325dde8a25d1e3a7efb50b431641b">More...</a><br /></td></tr>
|
|
<tr class="separator:a20e325dde8a25d1e3a7efb50b431641b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae7361f6159006e3f87cbe10ba2a76329"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classwinstd_1_1handle.html#ae7361f6159006e3f87cbe10ba2a76329">operator></a> (<a class="el" href="classwinstd_1_1handle.html#a3dda19199ecfbc378c932e7d84d0ea81">handle_type</a> h) const</td></tr>
|
|
<tr class="memdesc:ae7361f6159006e3f87cbe10ba2a76329"><td class="mdescLeft"> </td><td class="mdescRight">Is handle greater than? <a href="classwinstd_1_1handle.html#ae7361f6159006e3f87cbe10ba2a76329">More...</a><br /></td></tr>
|
|
<tr class="separator:ae7361f6159006e3f87cbe10ba2a76329"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6df58f6c131ab4288acb96d5b8f3012e"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classwinstd_1_1handle.html#a6df58f6c131ab4288acb96d5b8f3012e">operator!=</a> (<a class="el" href="classwinstd_1_1handle.html#a3dda19199ecfbc378c932e7d84d0ea81">handle_type</a> h) const</td></tr>
|
|
<tr class="memdesc:a6df58f6c131ab4288acb96d5b8f3012e"><td class="mdescLeft"> </td><td class="mdescRight">Is handle not equal to? <a href="classwinstd_1_1handle.html#a6df58f6c131ab4288acb96d5b8f3012e">More...</a><br /></td></tr>
|
|
<tr class="separator:a6df58f6c131ab4288acb96d5b8f3012e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab6021e9c11accef6b813948dc4601ddc"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classwinstd_1_1handle.html#ab6021e9c11accef6b813948dc4601ddc">operator==</a> (<a class="el" href="classwinstd_1_1handle.html#a3dda19199ecfbc378c932e7d84d0ea81">handle_type</a> h) const</td></tr>
|
|
<tr class="memdesc:ab6021e9c11accef6b813948dc4601ddc"><td class="mdescLeft"> </td><td class="mdescRight">Is handle equal to? <a href="classwinstd_1_1handle.html#ab6021e9c11accef6b813948dc4601ddc">More...</a><br /></td></tr>
|
|
<tr class="separator:ab6021e9c11accef6b813948dc4601ddc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab2a98042c3b88fda687e34d370756f11"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classwinstd_1_1handle.html#ab2a98042c3b88fda687e34d370756f11">attach</a> (<a class="el" href="classwinstd_1_1handle.html#a3dda19199ecfbc378c932e7d84d0ea81">handle_type</a> h) noexcept</td></tr>
|
|
<tr class="memdesc:ab2a98042c3b88fda687e34d370756f11"><td class="mdescLeft"> </td><td class="mdescRight">Sets a new object handle for the class. <a href="classwinstd_1_1handle.html#ab2a98042c3b88fda687e34d370756f11">More...</a><br /></td></tr>
|
|
<tr class="separator:ab2a98042c3b88fda687e34d370756f11"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad5acf6ce53e092b8d4d53f909cf321f9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classwinstd_1_1handle.html#a3dda19199ecfbc378c932e7d84d0ea81">handle_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classwinstd_1_1handle.html#ad5acf6ce53e092b8d4d53f909cf321f9">detach</a> ()</td></tr>
|
|
<tr class="memdesc:ad5acf6ce53e092b8d4d53f909cf321f9"><td class="mdescLeft"> </td><td class="mdescRight">Dismisses the object handle from this class. <a href="classwinstd_1_1handle.html#ad5acf6ce53e092b8d4d53f909cf321f9">More...</a><br /></td></tr>
|
|
<tr class="separator:ad5acf6ce53e092b8d4d53f909cf321f9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a706aaab7691a472c608890f8e5dd0d96"><td class="memItemLeft" align="right" valign="top"><a id="a706aaab7691a472c608890f8e5dd0d96" name="a706aaab7691a472c608890f8e5dd0d96"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>free</b> ()</td></tr>
|
|
<tr class="memdesc:a706aaab7691a472c608890f8e5dd0d96"><td class="mdescLeft"> </td><td class="mdescRight">Destroys the object. <br /></td></tr>
|
|
<tr class="separator:a706aaab7691a472c608890f8e5dd0d96"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-attribs" name="pub-static-attribs"></a>
|
|
Static Public Attributes</h2></td></tr>
|
|
<tr class="memitem:gacf43e306968474166474090690857e1c"><td class="memItemLeft" align="right" valign="top">
|
|
static const T </td><td class="memItemRight" valign="bottom"><b>invalid</b> = INVAL</td></tr>
|
|
<tr class="memdesc:gacf43e306968474166474090690857e1c"><td class="mdescLeft"> </td><td class="mdescRight">Invalid handle value. <br /></td></tr>
|
|
<tr class="separator:gacf43e306968474166474090690857e1c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-methods" name="pro-methods"></a>
|
|
Protected Member Functions</h2></td></tr>
|
|
<tr class="memitem:a137560600851eb4c3e4b80e25d4da629"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classwinstd_1_1handle.html#a137560600851eb4c3e4b80e25d4da629">free_internal</a> () noexcept=0</td></tr>
|
|
<tr class="memdesc:a137560600851eb4c3e4b80e25d4da629"><td class="mdescLeft"> </td><td class="mdescRight">Abstract member function that must be implemented by child classes to do the actual object destruction. <a href="classwinstd_1_1handle.html#a137560600851eb4c3e4b80e25d4da629">More...</a><br /></td></tr>
|
|
<tr class="separator:a137560600851eb4c3e4b80e25d4da629"><td class="memSeparator" colspan="2"> </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:aabde3f16fd98b06b3b0282ef7806eb59"><td class="memItemLeft" align="right" valign="top"><a id="aabde3f16fd98b06b3b0282ef7806eb59" name="aabde3f16fd98b06b3b0282ef7806eb59"></a>
|
|
<a class="el" href="classwinstd_1_1handle.html#a3dda19199ecfbc378c932e7d84d0ea81">handle_type</a> </td><td class="memItemRight" valign="bottom"><b>m_h</b></td></tr>
|
|
<tr class="memdesc:aabde3f16fd98b06b3b0282ef7806eb59"><td class="mdescLeft"> </td><td class="mdescRight">Object handle. <br /></td></tr>
|
|
<tr class="separator:aabde3f16fd98b06b3b0282ef7806eb59"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><div class="compoundTemplParams">template<class T, const T INVAL><br />
|
|
class winstd::handle< T, INVAL ></div><p >Base abstract template class to support generic object handle keeping. </p>
|
|
<p >It provides basic operators and methods common to all descendands of this class establishing a base to ease the replacement of native object handle type with classes in object-oriented approach. </p>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="a4a0f9b6caadf4a55c7bc0dcc0ce39dac" name="a4a0f9b6caadf4a55c7bc0dcc0ce39dac"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4a0f9b6caadf4a55c7bc0dcc0ce39dac">◆ </a></span>handle() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<class T , const T INVAL> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classwinstd_1_1handle.html">winstd::handle</a>< T, INVAL >::handle </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classwinstd_1_1handle.html#a3dda19199ecfbc378c932e7d84d0ea81">handle_type</a> </td>
|
|
<td class="paramname"><em>h</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Initializes a new class instance with an already available object handle. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">h</td><td>Initial object handle value </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ac52f342530bb97ce1ff255a7054547d5" name="ac52f342530bb97ce1ff255a7054547d5"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac52f342530bb97ce1ff255a7054547d5">◆ </a></span>handle() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<class T , const T INVAL> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classwinstd_1_1handle.html">winstd::handle</a>< T, INVAL >::handle </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classwinstd_1_1handle.html">handle</a>< <a class="el" href="classwinstd_1_1handle.html#a3dda19199ecfbc378c932e7d84d0ea81">handle_type</a>, INVAL > && </td>
|
|
<td class="paramname"><em>h</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Move constructor. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in,out]</td><td class="paramname">h</td><td>A rvalue reference of another object </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="ab2a98042c3b88fda687e34d370756f11" name="ab2a98042c3b88fda687e34d370756f11"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab2a98042c3b88fda687e34d370756f11">◆ </a></span>attach()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<class T , const T INVAL> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void <a class="el" href="classwinstd_1_1handle.html">winstd::handle</a>< T, INVAL >::attach </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classwinstd_1_1handle.html#a3dda19199ecfbc378c932e7d84d0ea81">handle_type</a> </td>
|
|
<td class="paramname"><em>h</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets a new object handle for the class. </p>
|
|
<p >When the current object handle of the class is non-INVAL, the object is destroyed first.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">h</td><td>New object handle </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad5acf6ce53e092b8d4d53f909cf321f9" name="ad5acf6ce53e092b8d4d53f909cf321f9"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad5acf6ce53e092b8d4d53f909cf321f9">◆ </a></span>detach()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<class T , const T INVAL> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classwinstd_1_1handle.html#a3dda19199ecfbc378c932e7d84d0ea81">handle_type</a> <a class="el" href="classwinstd_1_1handle.html">winstd::handle</a>< T, INVAL >::detach </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Dismisses the object handle from this class. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Object handle </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a137560600851eb4c3e4b80e25d4da629" name="a137560600851eb4c3e4b80e25d4da629"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a137560600851eb4c3e4b80e25d4da629">◆ </a></span>free_internal()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<class T , const T INVAL> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual void <a class="el" href="classwinstd_1_1handle.html">winstd::handle</a>< T, INVAL >::free_internal </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">pure virtual</span><span class="mlabel">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Abstract member function that must be implemented by child classes to do the actual object destruction. </p>
|
|
|
|
<p>Implemented in <a class="el" href="classwinstd_1_1com__obj.html#a028b86f770253f74a62ca3eaebb14de5">winstd::com_obj< T ></a>, <a class="el" href="classwinstd_1_1bstr.html#a87edcb348af7d69ad86709e32b519870">winstd::bstr</a>, <a class="el" href="classwinstd_1_1cert__context.html#a1615ec6693eb68764543456ad418a970">winstd::cert_context</a>, <a class="el" href="classwinstd_1_1cert__chain__context.html#ae15044b1a7be10d96643d3921e149ee6">winstd::cert_chain_context</a>, <a class="el" href="classwinstd_1_1cert__store.html#ab709fe692a4117173eae26e741da2069">winstd::cert_store</a>, <a class="el" href="classwinstd_1_1crypt__prov.html#aa351d2dbc42daf51dddcf847fd95c39f">winstd::crypt_prov</a>, <a class="el" href="classwinstd_1_1crypt__hash.html#a3c19a87b4ff646d9e87524feac4e41b5">winstd::crypt_hash</a>, <a class="el" href="classwinstd_1_1crypt__key.html#acf2f2ad35dd7602adcdeef17f605e391">winstd::crypt_key</a>, <a class="el" href="classwinstd_1_1eap__packet.html#a6d68149b92c1564b2683ddb3a87b60f0">winstd::eap_packet</a>, <a class="el" href="classwinstd_1_1event__provider.html#ad0d7ed652fe897a94f2ef198dd3f41a1">winstd::event_provider</a>, <a class="el" href="classwinstd_1_1event__session.html#a4701ad4ae9d18e890ed4066473680751">winstd::event_session</a>, <a class="el" href="classwinstd_1_1event__trace.html#ad8ef9b0616775c44e911d9db4676b19c">winstd::event_trace</a>, <a class="el" href="classwinstd_1_1gdi__handle.html#a777cd2403d6b8d0fb0a4b69c82fcca87">winstd::gdi_handle< T ></a>, <a class="el" href="classwinstd_1_1dc.html#ad3dc9d48645022e7a1adcdb9ea01a557">winstd::dc</a>, <a class="el" href="classwinstd_1_1window__dc.html#a351bae4203ad766c94f4fc6eac74e98a">winstd::window_dc</a>, <a class="el" href="classwinstd_1_1sec__credentials.html#a6156649d1a93696c8369361cb426e260">winstd::sec_credentials</a>, <a class="el" href="classwinstd_1_1sec__context.html#afe8682a77fe50e5818ee6c4c741f36d9">winstd::sec_context</a>, <a class="el" href="classwinstd_1_1setup__device__info__list.html#a41f013a37e16074f1972fd279f8c1437">winstd::setup_device_info_list</a>, <a class="el" href="classwinstd_1_1win__handle.html#a456fe19828113913f42e901f112c6455">winstd::win_handle< INVALID ></a>, <a class="el" href="classwinstd_1_1library.html#a0c602319cb498fa2b6a5c4eda4a150aa">winstd::library</a>, <a class="el" href="classwinstd_1_1find__file.html#a5bb4f7e12689153f991ffcb08dbbe703">winstd::find_file</a>, <a class="el" href="classwinstd_1_1heap.html#ae25434d96356a74d27c0b3b0e268df45">winstd::heap</a>, <a class="el" href="classwinstd_1_1vmemory.html#a616dbfba873b9a3dcf393cff6504fc2e">winstd::vmemory</a>, <a class="el" href="classwinstd_1_1reg__key.html#a3dba00d2105a1c633c571d8ad3131f54">winstd::reg_key</a>, <a class="el" href="classwinstd_1_1security__id.html#a464626311e64ea1273fd6bca9ef93a73">winstd::security_id</a>, <a class="el" href="classwinstd_1_1event__log.html#a3e7c083403f5692926aff600f6ead52e">winstd::event_log</a>, <a class="el" href="classwinstd_1_1sc__handle.html#a3db1b2080f7e26c896aa9c47c230e64d">winstd::sc_handle</a>, <a class="el" href="classwinstd_1_1addrinfo.html#a279ad84ce2877b22797eedbec80cd55f">winstd::addrinfo</a>, <a class="el" href="classwinstd_1_1waddrinfo.html#a479f7602b60a4c4205a9327f91e25f66">winstd::waddrinfo</a>, and <a class="el" href="classwinstd_1_1wlan__handle.html#a86e2b4aa2a5177b6ebac0258099f9261">winstd::wlan_handle</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a86114637674c82d6fd96d7b3eae39ac8" name="a86114637674c82d6fd96d7b3eae39ac8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a86114637674c82d6fd96d7b3eae39ac8">◆ </a></span>operator handle_type()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<class T , const T INVAL> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classwinstd_1_1handle.html">winstd::handle</a>< T, INVAL >::operator <a class="el" href="classwinstd_1_1handle.html#a3dda19199ecfbc378c932e7d84d0ea81">handle_type</a> </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Auto-typecasting operator. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Object handle </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a5df08ecb32b9040bf7342479aee2286c" name="a5df08ecb32b9040bf7342479aee2286c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5df08ecb32b9040bf7342479aee2286c">◆ </a></span>operator!()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<class T , const T INVAL> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool <a class="el" href="classwinstd_1_1handle.html">winstd::handle</a>< T, INVAL >::operator! </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Tests if the object handle is invalid. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd><ul>
|
|
<li>Non zero when object handle is invalid;</li>
|
|
<li>Zero otherwise.</li>
|
|
</ul>
|
|
</dd></dl>
|
|
<dl class="section note"><dt>Note</dt><dd>Implementing <code>operator bool() const</code> would be correct C++ approach here. Unfortunately, it would produce ambiguities where <code>bool</code> and <code>handle_type</code> are polymorphed. Use <code>!!</code> to test if the object handle is valid. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a6df58f6c131ab4288acb96d5b8f3012e" name="a6df58f6c131ab4288acb96d5b8f3012e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6df58f6c131ab4288acb96d5b8f3012e">◆ </a></span>operator!=()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<class T , const T INVAL> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool <a class="el" href="classwinstd_1_1handle.html">winstd::handle</a>< T, INVAL ><a class="el" href="classwinstd_1_1handle.html#a5df08ecb32b9040bf7342479aee2286c">::operator!</a>= </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classwinstd_1_1handle.html#a3dda19199ecfbc378c932e7d84d0ea81">handle_type</a> </td>
|
|
<td class="paramname"><em>h</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Is handle not equal to? </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">h</td><td>Object handle to compare against </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><ul>
|
|
<li>Non zero when object handle is not equal to h;</li>
|
|
<li>Zero otherwise. </li>
|
|
</ul>
|
|
</dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a2bd2de7bb89dcebe2c9379dd54ee79c1" name="a2bd2de7bb89dcebe2c9379dd54ee79c1"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2bd2de7bb89dcebe2c9379dd54ee79c1">◆ </a></span>operator&()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<class T , const T INVAL> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classwinstd_1_1handle.html#a3dda19199ecfbc378c932e7d84d0ea81">handle_type</a> * <a class="el" href="classwinstd_1_1handle.html">winstd::handle</a>< T, INVAL >::operator& </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns the object handle reference. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Object handle reference </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0f1ac60cf62e41c24394bf0e3457fbd9" name="a0f1ac60cf62e41c24394bf0e3457fbd9"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0f1ac60cf62e41c24394bf0e3457fbd9">◆ </a></span>operator*()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<class T , const T INVAL> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classwinstd_1_1handle.html#a3dda19199ecfbc378c932e7d84d0ea81">handle_type</a> *& <a class="el" href="classwinstd_1_1handle.html">winstd::handle</a>< T, INVAL >::operator* </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns the object handle value when the object handle is a pointer to a value (class, struct, etc.). </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Object handle value </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a285ada5936fe7afdd12eed70b38c2084" name="a285ada5936fe7afdd12eed70b38c2084"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a285ada5936fe7afdd12eed70b38c2084">◆ </a></span>operator->()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<class T , const T INVAL> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classwinstd_1_1handle.html#a3dda19199ecfbc378c932e7d84d0ea81">handle_type</a> <a class="el" href="classwinstd_1_1handle.html">winstd::handle</a>< T, INVAL >::operator-> </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Provides object handle member access when the object handle is a pointer to a class or struct. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Object handle </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a4c4515d0d1071cab5c675e926aa2dc92" name="a4c4515d0d1071cab5c675e926aa2dc92"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4c4515d0d1071cab5c675e926aa2dc92">◆ </a></span>operator<()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<class T , const T INVAL> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool <a class="el" href="classwinstd_1_1handle.html">winstd::handle</a>< T, INVAL >::operator< </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classwinstd_1_1handle.html#a3dda19199ecfbc378c932e7d84d0ea81">handle_type</a> </td>
|
|
<td class="paramname"><em>h</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Is handle less than? </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">h</td><td>Object handle to compare against </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><ul>
|
|
<li>Non zero when object handle is less than h;</li>
|
|
<li>Zero otherwise. </li>
|
|
</ul>
|
|
</dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af9e9538d58b952799db4a1c68b0184b9" name="af9e9538d58b952799db4a1c68b0184b9"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af9e9538d58b952799db4a1c68b0184b9">◆ </a></span>operator<=()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<class T , const T INVAL> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool <a class="el" href="classwinstd_1_1handle.html">winstd::handle</a>< T, INVAL >::operator<= </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classwinstd_1_1handle.html#a3dda19199ecfbc378c932e7d84d0ea81">handle_type</a> </td>
|
|
<td class="paramname"><em>h</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Is handle less than or equal to? </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">h</td><td>Object handle to compare against </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><ul>
|
|
<li>Non zero when object handle is less than or equal to h;</li>
|
|
<li>Zero otherwise. </li>
|
|
</ul>
|
|
</dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a6326bbc54ec3441e41f30bc1ec4d6a6c" name="a6326bbc54ec3441e41f30bc1ec4d6a6c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6326bbc54ec3441e41f30bc1ec4d6a6c">◆ </a></span>operator=() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<class T , const T INVAL> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classwinstd_1_1handle.html">handle</a>< <a class="el" href="classwinstd_1_1handle.html#a3dda19199ecfbc378c932e7d84d0ea81">handle_type</a>, INVAL > & <a class="el" href="classwinstd_1_1handle.html">winstd::handle</a>< T, INVAL >::operator= </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classwinstd_1_1handle.html">handle</a>< <a class="el" href="classwinstd_1_1handle.html#a3dda19199ecfbc378c932e7d84d0ea81">handle_type</a>, INVAL > && </td>
|
|
<td class="paramname"><em>h</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Move assignment. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in,out]</td><td class="paramname">h</td><td>A rvalue reference of another object </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a591e006af92e4d088fb9c1ed974c0923" name="a591e006af92e4d088fb9c1ed974c0923"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a591e006af92e4d088fb9c1ed974c0923">◆ </a></span>operator=() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<class T , const T INVAL> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classwinstd_1_1handle.html">handle</a>< <a class="el" href="classwinstd_1_1handle.html#a3dda19199ecfbc378c932e7d84d0ea81">handle_type</a>, INVAL > & <a class="el" href="classwinstd_1_1handle.html">winstd::handle</a>< T, INVAL >::operator= </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classwinstd_1_1handle.html#a3dda19199ecfbc378c932e7d84d0ea81">handle_type</a> </td>
|
|
<td class="paramname"><em>h</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Attaches already available object handle. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">h</td><td>Object handle value </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab6021e9c11accef6b813948dc4601ddc" name="ab6021e9c11accef6b813948dc4601ddc"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab6021e9c11accef6b813948dc4601ddc">◆ </a></span>operator==()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<class T , const T INVAL> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool <a class="el" href="classwinstd_1_1handle.html">winstd::handle</a>< T, INVAL >::operator== </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classwinstd_1_1handle.html#a3dda19199ecfbc378c932e7d84d0ea81">handle_type</a> </td>
|
|
<td class="paramname"><em>h</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Is handle equal to? </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">h</td><td>Object handle to compare against </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><ul>
|
|
<li>Non zero when object handle is equal to h;</li>
|
|
<li>Zero otherwise. </li>
|
|
</ul>
|
|
</dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae7361f6159006e3f87cbe10ba2a76329" name="ae7361f6159006e3f87cbe10ba2a76329"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae7361f6159006e3f87cbe10ba2a76329">◆ </a></span>operator>()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<class T , const T INVAL> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool <a class="el" href="classwinstd_1_1handle.html">winstd::handle</a>< T, INVAL >::operator> </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classwinstd_1_1handle.html#a3dda19199ecfbc378c932e7d84d0ea81">handle_type</a> </td>
|
|
<td class="paramname"><em>h</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Is handle greater than? </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">h</td><td>Object handle to compare against </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><ul>
|
|
<li>Non zero when object handle is greater than h;</li>
|
|
<li>Zero otherwise. </li>
|
|
</ul>
|
|
</dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a20e325dde8a25d1e3a7efb50b431641b" name="a20e325dde8a25d1e3a7efb50b431641b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a20e325dde8a25d1e3a7efb50b431641b">◆ </a></span>operator>=()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<class T , const T INVAL> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool <a class="el" href="classwinstd_1_1handle.html">winstd::handle</a>< T, INVAL >::operator>= </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classwinstd_1_1handle.html#a3dda19199ecfbc378c932e7d84d0ea81">handle_type</a> </td>
|
|
<td class="paramname"><em>h</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Is handle greater than or equal to? </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">h</td><td>Object handle to compare against </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><ul>
|
|
<li>Non zero when object handle is greater than or equal to h;</li>
|
|
<li>Zero otherwise. </li>
|
|
</ul>
|
|
</dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following file:<ul>
|
|
<li>include/WinStd/<a class="el" href="_common_8h_source.html">Common.h</a></li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated on Fri Oct 28 2022 06:03:36 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.5
|
|
</small></address>
|
|
</body>
|
|
</html>
|