WinStd/classwinstd_1_1impersonator.html

178 lines
9.2 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.12.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>WinStd: winstd::impersonator 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>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.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.12.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">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @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',false);
$(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){ initResizable(false); });
/* @license-end */
</script>
<!-- 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_1impersonator.html">impersonator</a></li> </ul>
</div>
</div><!-- top -->
<div id="doc-content">
<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_1impersonator-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">winstd::impersonator Class Reference<div class="ingroups"><a class="el" href="group___win_std_win_a_p_i.html">Windows API</a></div></div></div>
</div><!--header-->
<div class="contents">
<p>Base class for thread impersonation of another security context.
<a href="#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="_win_8h_source.html">WinStd/Win.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for winstd::impersonator:</div>
<div class="dyncontent">
<div class="center">
<img src="classwinstd_1_1impersonator.png" usemap="#winstd::impersonator_map" alt=""/>
<map id="winstd::impersonator_map" name="winstd::impersonator_map">
<area href="classwinstd_1_1system__impersonator.html" title="Lets the calling thread impersonate the security context of the SYSTEM user." alt="winstd::system_impersonator" shape="rect" coords="0,56,171,80"/>
<area href="classwinstd_1_1user__impersonator.html" title="Lets the calling thread impersonate the security context of a logged-on user." alt="winstd::user_impersonator" shape="rect" coords="181,56,352,80"/>
</map>
</div></div>
<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:a6d6a8f6446fd2f5bc2120318164f0eac" id="r_a6d6a8f6446fd2f5bc2120318164f0eac"><td class="memItemLeft" align="right" valign="top"><a id="a6d6a8f6446fd2f5bc2120318164f0eac" name="a6d6a8f6446fd2f5bc2120318164f0eac"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>impersonator</b> () noexcept</td></tr>
<tr class="memdesc:a6d6a8f6446fd2f5bc2120318164f0eac"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct the impersonator. <br /></td></tr>
<tr class="separator:a6d6a8f6446fd2f5bc2120318164f0eac"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a272883abcb25c9563ca5b919c0d9d71d" id="r_a272883abcb25c9563ca5b919c0d9d71d"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a272883abcb25c9563ca5b919c0d9d71d">~impersonator</a> ()</td></tr>
<tr class="memdesc:a272883abcb25c9563ca5b919c0d9d71d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reverts to current user and destructs the impersonator. <br /></td></tr>
<tr class="separator:a272883abcb25c9563ca5b919c0d9d71d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0c295840090719079dbf5e5b691e6c3e" id="r_a0c295840090719079dbf5e5b691e6c3e"><td class="memItemLeft" align="right" valign="top"><a id="a0c295840090719079dbf5e5b691e6c3e" name="a0c295840090719079dbf5e5b691e6c3e"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>operator bool</b> () const</td></tr>
<tr class="memdesc:a0c295840090719079dbf5e5b691e6c3e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Did impersonation succeed? <br /></td></tr>
<tr class="separator:a0c295840090719079dbf5e5b691e6c3e"><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:acf82d1c062fce491af05b7e89c09d3f2" id="r_acf82d1c062fce491af05b7e89c09d3f2"><td class="memItemLeft" align="right" valign="top"><a id="acf82d1c062fce491af05b7e89c09d3f2" name="acf82d1c062fce491af05b7e89c09d3f2"></a>
BOOL&#160;</td><td class="memItemRight" valign="bottom"><b>m_cookie</b></td></tr>
<tr class="memdesc:acf82d1c062fce491af05b7e89c09d3f2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Did impersonation succeed? <br /></td></tr>
<tr class="separator:acf82d1c062fce491af05b7e89c09d3f2"><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>Base class for thread impersonation of another security context. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a272883abcb25c9563ca5b919c0d9d71d" name="a272883abcb25c9563ca5b919c0d9d71d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a272883abcb25c9563ca5b919c0d9d71d">&#9670;&#160;</a></span>~impersonator()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual winstd::impersonator::~impersonator </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Reverts to current user and destructs the impersonator. </p>
<dl class="section see"><dt>See also</dt><dd><a href="https://msdn.microsoft.com/en-us/library/windows/desktop/aa379317.aspx">RevertToSelf function</a> </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>include/WinStd/<a class="el" href="_win_8h_source.html">Win.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue Nov 19 2024 10:18:28 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.12.0
</small></address>
</div><!-- doc-content -->
</body>
</html>