Amebis/WinStd
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
WinStd/classwinstd_1_1reg__key.html

435 lines
36 KiB
HTML
Raw Blame History

<!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">
<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.3"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>WinStd: winstd::reg_key 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>
<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">Additional templates and function helpers for Microsoft Windows using Standard C++ classes</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.3 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'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');
$(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">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><b>winstd</b></li><li class="navelem"><a class="el" href="classwinstd_1_1reg__key.html">reg_key</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="classwinstd_1_1reg__key-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">winstd::reg_key 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>Registry wrapper class.
<a href="classwinstd_1_1reg__key.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="_win_8h_source.html">Win.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for winstd::reg_key:</div>
<div class="dyncontent">
<div class="center">
<img src="classwinstd_1_1reg__key.png" usemap="#winstd::reg_5Fkey_map" alt=""/>
<map id="winstd::reg_5Fkey_map" name="winstd::reg_5Fkey_map">
<area href="classwinstd_1_1handle.html" alt="winstd::handle&lt; HKEY, NULL &gt;" shape="rect" coords="0,0,189,24"/>
</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:ae54556effe6fe91942f87fc8c8ff5d7c"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwinstd_1_1reg__key.html#ae54556effe6fe91942f87fc8c8ff5d7c">~reg_key</a> ()</td></tr>
<tr class="memdesc:ae54556effe6fe91942f87fc8c8ff5d7c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Closes a handle to the registry key. <a href="classwinstd_1_1reg__key.html#ae54556effe6fe91942f87fc8c8ff5d7c">More...</a><br /></td></tr>
<tr class="separator:ae54556effe6fe91942f87fc8c8ff5d7c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a63252cffe53e75e84894ee5567eb5c53"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwinstd_1_1reg__key.html#a63252cffe53e75e84894ee5567eb5c53">create</a> (_In_ HKEY hKey, _In_z_ LPCTSTR lpSubKey, _In_opt_ LPTSTR lpClass, _In_ DWORD dwOptions, _In_ REGSAM samDesired, _In_opt_ LPSECURITY_ATTRIBUTES lpSecurityAttributes=NULL, _Out_opt_ LPDWORD lpdwDisposition=NULL) noexcept</td></tr>
<tr class="memdesc:a63252cffe53e75e84894ee5567eb5c53"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates the specified registry key. If the key already exists, the function opens it. <a href="classwinstd_1_1reg__key.html#a63252cffe53e75e84894ee5567eb5c53">More...</a><br /></td></tr>
<tr class="separator:a63252cffe53e75e84894ee5567eb5c53"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1f6008b49c2a450dfdfecf204a8eab0f"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwinstd_1_1reg__key.html#a1f6008b49c2a450dfdfecf204a8eab0f">open</a> (_In_ HKEY hKey, _In_opt_z_ LPCTSTR lpSubKey, _In_ DWORD ulOptions, _In_ REGSAM samDesired) noexcept</td></tr>
<tr class="memdesc:a1f6008b49c2a450dfdfecf204a8eab0f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Opens the specified registry key. <a href="classwinstd_1_1reg__key.html#a1f6008b49c2a450dfdfecf204a8eab0f">More...</a><br /></td></tr>
<tr class="separator:a1f6008b49c2a450dfdfecf204a8eab0f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a383dc95733bec990eae644ad6fcb8b4c"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwinstd_1_1reg__key.html#a383dc95733bec990eae644ad6fcb8b4c">delete_subkey</a> (_In_z_ LPCTSTR szSubkey)</td></tr>
<tr class="memdesc:a383dc95733bec990eae644ad6fcb8b4c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Deletes the specified registry subkey. <a href="classwinstd_1_1reg__key.html#a383dc95733bec990eae644ad6fcb8b4c">More...</a><br /></td></tr>
<tr class="separator:a383dc95733bec990eae644ad6fcb8b4c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classwinstd_1_1handle"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classwinstd_1_1handle')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classwinstd_1_1handle.html">winstd::handle&lt; HKEY, NULL &gt;</a></td></tr>
<tr class="memitem:a1b9c4f9529c9efa7d16dec8bab3b00e4 inherit pub_methods_classwinstd_1_1handle"><td class="memItemLeft" align="right" valign="top"><a id="a1b9c4f9529c9efa7d16dec8bab3b00e4" name="a1b9c4f9529c9efa7d16dec8bab3b00e4"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>handle</b> () noexcept</td></tr>
<tr class="memdesc:a1b9c4f9529c9efa7d16dec8bab3b00e4 inherit pub_methods_classwinstd_1_1handle"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializes a new class instance with the object handle set to INVAL. <br /></td></tr>
<tr class="separator:a1b9c4f9529c9efa7d16dec8bab3b00e4 inherit pub_methods_classwinstd_1_1handle"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a200e93ad6b773e634094f5321705ebec inherit pub_methods_classwinstd_1_1handle"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwinstd_1_1handle.html#a200e93ad6b773e634094f5321705ebec">handle</a> (_In_opt_ <a class="el" href="classwinstd_1_1handle.html#a3dda19199ecfbc378c932e7d84d0ea81">handle_type</a> h) noexcept</td></tr>
<tr class="memdesc:a200e93ad6b773e634094f5321705ebec inherit pub_methods_classwinstd_1_1handle"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializes a new class instance with an already available object handle. <a href="classwinstd_1_1handle.html#a200e93ad6b773e634094f5321705ebec">More...</a><br /></td></tr>
<tr class="separator:a200e93ad6b773e634094f5321705ebec inherit pub_methods_classwinstd_1_1handle"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a54141e1a6c82fcdd15f6fa3a813baab0 inherit pub_methods_classwinstd_1_1handle"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwinstd_1_1handle.html#a54141e1a6c82fcdd15f6fa3a813baab0">handle</a> (_Inout_ <a class="el" href="classwinstd_1_1handle.html">handle</a>&lt; <a class="el" href="classwinstd_1_1handle.html#a3dda19199ecfbc378c932e7d84d0ea81">handle_type</a>, INVAL &gt; &amp;&amp;h) noexcept</td></tr>
<tr class="memdesc:a54141e1a6c82fcdd15f6fa3a813baab0 inherit pub_methods_classwinstd_1_1handle"><td class="mdescLeft">&#160;</td><td class="mdescRight">Move constructor. <a href="classwinstd_1_1handle.html#a54141e1a6c82fcdd15f6fa3a813baab0">More...</a><br /></td></tr>
<tr class="separator:a54141e1a6c82fcdd15f6fa3a813baab0 inherit pub_methods_classwinstd_1_1handle"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8928de8288f8dc990fc903dee85803e7 inherit pub_methods_classwinstd_1_1handle"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classwinstd_1_1handle.html">handle</a>&lt; <a class="el" href="classwinstd_1_1handle.html#a3dda19199ecfbc378c932e7d84d0ea81">handle_type</a>, INVAL &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwinstd_1_1handle.html#a8928de8288f8dc990fc903dee85803e7">operator=</a> (_In_opt_ <a class="el" href="classwinstd_1_1handle.html#a3dda19199ecfbc378c932e7d84d0ea81">handle_type</a> h) noexcept</td></tr>
<tr class="memdesc:a8928de8288f8dc990fc903dee85803e7 inherit pub_methods_classwinstd_1_1handle"><td class="mdescLeft">&#160;</td><td class="mdescRight">Attaches already available object handle. <a href="classwinstd_1_1handle.html#a8928de8288f8dc990fc903dee85803e7">More...</a><br /></td></tr>
<tr class="separator:a8928de8288f8dc990fc903dee85803e7 inherit pub_methods_classwinstd_1_1handle"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a96a1bcf085561569ed51ab23968d1308 inherit pub_methods_classwinstd_1_1handle"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classwinstd_1_1handle.html">handle</a>&lt; <a class="el" href="classwinstd_1_1handle.html#a3dda19199ecfbc378c932e7d84d0ea81">handle_type</a>, INVAL &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwinstd_1_1handle.html#a96a1bcf085561569ed51ab23968d1308">operator=</a> (_Inout_ <a class="el" href="classwinstd_1_1handle.html">handle</a>&lt; <a class="el" href="classwinstd_1_1handle.html#a3dda19199ecfbc378c932e7d84d0ea81">handle_type</a>, INVAL &gt; &amp;&amp;h) noexcept</td></tr>
<tr class="memdesc:a96a1bcf085561569ed51ab23968d1308 inherit pub_methods_classwinstd_1_1handle"><td class="mdescLeft">&#160;</td><td class="mdescRight">Move assignment. <a href="classwinstd_1_1handle.html#a96a1bcf085561569ed51ab23968d1308">More...</a><br /></td></tr>
<tr class="separator:a96a1bcf085561569ed51ab23968d1308 inherit pub_methods_classwinstd_1_1handle"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a86114637674c82d6fd96d7b3eae39ac8 inherit pub_methods_classwinstd_1_1handle"><td class="memItemLeft" align="right" valign="top">&#160;</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 inherit pub_methods_classwinstd_1_1handle"><td class="mdescLeft">&#160;</td><td class="mdescRight">Auto-typecasting operator. <a href="classwinstd_1_1handle.html#a86114637674c82d6fd96d7b3eae39ac8">More...</a><br /></td></tr>
<tr class="separator:a86114637674c82d6fd96d7b3eae39ac8 inherit pub_methods_classwinstd_1_1handle"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0f1ac60cf62e41c24394bf0e3457fbd9 inherit pub_methods_classwinstd_1_1handle"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classwinstd_1_1handle.html#a3dda19199ecfbc378c932e7d84d0ea81">handle_type</a> *&amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwinstd_1_1handle.html#a0f1ac60cf62e41c24394bf0e3457fbd9">operator*</a> () const</td></tr>
<tr class="memdesc:a0f1ac60cf62e41c24394bf0e3457fbd9 inherit pub_methods_classwinstd_1_1handle"><td class="mdescLeft">&#160;</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 inherit pub_methods_classwinstd_1_1handle"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2bd2de7bb89dcebe2c9379dd54ee79c1 inherit pub_methods_classwinstd_1_1handle"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classwinstd_1_1handle.html#a3dda19199ecfbc378c932e7d84d0ea81">handle_type</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwinstd_1_1handle.html#a2bd2de7bb89dcebe2c9379dd54ee79c1">operator&amp;</a> ()</td></tr>
<tr class="memdesc:a2bd2de7bb89dcebe2c9379dd54ee79c1 inherit pub_methods_classwinstd_1_1handle"><td class="mdescLeft">&#160;</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 inherit pub_methods_classwinstd_1_1handle"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a285ada5936fe7afdd12eed70b38c2084 inherit pub_methods_classwinstd_1_1handle"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classwinstd_1_1handle.html#a3dda19199ecfbc378c932e7d84d0ea81">handle_type</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwinstd_1_1handle.html#a285ada5936fe7afdd12eed70b38c2084">operator-&gt;</a> () const</td></tr>
<tr class="memdesc:a285ada5936fe7afdd12eed70b38c2084 inherit pub_methods_classwinstd_1_1handle"><td class="mdescLeft">&#160;</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 inherit pub_methods_classwinstd_1_1handle"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5df08ecb32b9040bf7342479aee2286c inherit pub_methods_classwinstd_1_1handle"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwinstd_1_1handle.html#a5df08ecb32b9040bf7342479aee2286c">operator!</a> () const</td></tr>
<tr class="memdesc:a5df08ecb32b9040bf7342479aee2286c inherit pub_methods_classwinstd_1_1handle"><td class="mdescLeft">&#160;</td><td class="mdescRight">Tests if the object handle is INVAL. <a href="classwinstd_1_1handle.html#a5df08ecb32b9040bf7342479aee2286c">More...</a><br /></td></tr>
<tr class="separator:a5df08ecb32b9040bf7342479aee2286c inherit pub_methods_classwinstd_1_1handle"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a77b518be4199e6562520ccbcdcec5d07 inherit pub_methods_classwinstd_1_1handle"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwinstd_1_1handle.html#a77b518be4199e6562520ccbcdcec5d07">operator&lt;</a> (_In_opt_ <a class="el" href="classwinstd_1_1handle.html#a3dda19199ecfbc378c932e7d84d0ea81">handle_type</a> h) const</td></tr>
<tr class="memdesc:a77b518be4199e6562520ccbcdcec5d07 inherit pub_methods_classwinstd_1_1handle"><td class="mdescLeft">&#160;</td><td class="mdescRight">Is handle less than? <a href="classwinstd_1_1handle.html#a77b518be4199e6562520ccbcdcec5d07">More...</a><br /></td></tr>
<tr class="separator:a77b518be4199e6562520ccbcdcec5d07 inherit pub_methods_classwinstd_1_1handle"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a16b52280c04b4cb9f8bd65f76cb2f48d inherit pub_methods_classwinstd_1_1handle"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwinstd_1_1handle.html#a16b52280c04b4cb9f8bd65f76cb2f48d">operator&lt;=</a> (_In_opt_ <a class="el" href="classwinstd_1_1handle.html#a3dda19199ecfbc378c932e7d84d0ea81">handle_type</a> h) const</td></tr>
<tr class="memdesc:a16b52280c04b4cb9f8bd65f76cb2f48d inherit pub_methods_classwinstd_1_1handle"><td class="mdescLeft">&#160;</td><td class="mdescRight">Is handle less than or equal to? <a href="classwinstd_1_1handle.html#a16b52280c04b4cb9f8bd65f76cb2f48d">More...</a><br /></td></tr>
<tr class="separator:a16b52280c04b4cb9f8bd65f76cb2f48d inherit pub_methods_classwinstd_1_1handle"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a728f743b87f4bf56e184e45950154a2b inherit pub_methods_classwinstd_1_1handle"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwinstd_1_1handle.html#a728f743b87f4bf56e184e45950154a2b">operator&gt;=</a> (_In_opt_ <a class="el" href="classwinstd_1_1handle.html#a3dda19199ecfbc378c932e7d84d0ea81">handle_type</a> h) const</td></tr>
<tr class="memdesc:a728f743b87f4bf56e184e45950154a2b inherit pub_methods_classwinstd_1_1handle"><td class="mdescLeft">&#160;</td><td class="mdescRight">Is handle greater than or equal to? <a href="classwinstd_1_1handle.html#a728f743b87f4bf56e184e45950154a2b">More...</a><br /></td></tr>
<tr class="separator:a728f743b87f4bf56e184e45950154a2b inherit pub_methods_classwinstd_1_1handle"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa7db4bb5c15f7de56600ba02497c12eb inherit pub_methods_classwinstd_1_1handle"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwinstd_1_1handle.html#aa7db4bb5c15f7de56600ba02497c12eb">operator&gt;</a> (_In_opt_ <a class="el" href="classwinstd_1_1handle.html#a3dda19199ecfbc378c932e7d84d0ea81">handle_type</a> h) const</td></tr>
<tr class="memdesc:aa7db4bb5c15f7de56600ba02497c12eb inherit pub_methods_classwinstd_1_1handle"><td class="mdescLeft">&#160;</td><td class="mdescRight">Is handle greater than? <a href="classwinstd_1_1handle.html#aa7db4bb5c15f7de56600ba02497c12eb">More...</a><br /></td></tr>
<tr class="separator:aa7db4bb5c15f7de56600ba02497c12eb inherit pub_methods_classwinstd_1_1handle"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2c9e218fe1c13a2ffa0a81d829e72fee inherit pub_methods_classwinstd_1_1handle"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwinstd_1_1handle.html#a2c9e218fe1c13a2ffa0a81d829e72fee">operator!=</a> (_In_opt_ <a class="el" href="classwinstd_1_1handle.html#a3dda19199ecfbc378c932e7d84d0ea81">handle_type</a> h) const</td></tr>
<tr class="memdesc:a2c9e218fe1c13a2ffa0a81d829e72fee inherit pub_methods_classwinstd_1_1handle"><td class="mdescLeft">&#160;</td><td class="mdescRight">Is handle not equal to? <a href="classwinstd_1_1handle.html#a2c9e218fe1c13a2ffa0a81d829e72fee">More...</a><br /></td></tr>
<tr class="separator:a2c9e218fe1c13a2ffa0a81d829e72fee inherit pub_methods_classwinstd_1_1handle"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a308281d8c28014cc205e72f17f01635f inherit pub_methods_classwinstd_1_1handle"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwinstd_1_1handle.html#a308281d8c28014cc205e72f17f01635f">operator==</a> (_In_opt_ <a class="el" href="classwinstd_1_1handle.html#a3dda19199ecfbc378c932e7d84d0ea81">handle_type</a> h) const</td></tr>
<tr class="memdesc:a308281d8c28014cc205e72f17f01635f inherit pub_methods_classwinstd_1_1handle"><td class="mdescLeft">&#160;</td><td class="mdescRight">Is handle equal to? <a href="classwinstd_1_1handle.html#a308281d8c28014cc205e72f17f01635f">More...</a><br /></td></tr>
<tr class="separator:a308281d8c28014cc205e72f17f01635f inherit pub_methods_classwinstd_1_1handle"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a98d09f9c2970890a5c83a0c2aedd3a30 inherit pub_methods_classwinstd_1_1handle"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwinstd_1_1handle.html#a98d09f9c2970890a5c83a0c2aedd3a30">attach</a> (_In_opt_ <a class="el" href="classwinstd_1_1handle.html#a3dda19199ecfbc378c932e7d84d0ea81">handle_type</a> h) noexcept</td></tr>
<tr class="memdesc:a98d09f9c2970890a5c83a0c2aedd3a30 inherit pub_methods_classwinstd_1_1handle"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets a new object handle for the class. <a href="classwinstd_1_1handle.html#a98d09f9c2970890a5c83a0c2aedd3a30">More...</a><br /></td></tr>
<tr class="separator:a98d09f9c2970890a5c83a0c2aedd3a30 inherit pub_methods_classwinstd_1_1handle"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad5acf6ce53e092b8d4d53f909cf321f9 inherit pub_methods_classwinstd_1_1handle"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classwinstd_1_1handle.html#a3dda19199ecfbc378c932e7d84d0ea81">handle_type</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwinstd_1_1handle.html#ad5acf6ce53e092b8d4d53f909cf321f9">detach</a> ()</td></tr>
<tr class="memdesc:ad5acf6ce53e092b8d4d53f909cf321f9 inherit pub_methods_classwinstd_1_1handle"><td class="mdescLeft">&#160;</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 inherit pub_methods_classwinstd_1_1handle"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a706aaab7691a472c608890f8e5dd0d96 inherit pub_methods_classwinstd_1_1handle"><td class="memItemLeft" align="right" valign="top"><a id="a706aaab7691a472c608890f8e5dd0d96" name="a706aaab7691a472c608890f8e5dd0d96"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>free</b> ()</td></tr>
<tr class="memdesc:a706aaab7691a472c608890f8e5dd0d96 inherit pub_methods_classwinstd_1_1handle"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destroys the object. <br /></td></tr>
<tr class="separator:a706aaab7691a472c608890f8e5dd0d96 inherit pub_methods_classwinstd_1_1handle"><td class="memSeparator" colspan="2">&#160;</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:a3dba00d2105a1c633c571d8ad3131f54"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwinstd_1_1reg__key.html#a3dba00d2105a1c633c571d8ad3131f54">free_internal</a> () noexcept override</td></tr>
<tr class="memdesc:a3dba00d2105a1c633c571d8ad3131f54"><td class="mdescLeft">&#160;</td><td class="mdescRight">Closes a handle to the registry key. <a href="classwinstd_1_1reg__key.html#a3dba00d2105a1c633c571d8ad3131f54">More...</a><br /></td></tr>
<tr class="separator:a3dba00d2105a1c633c571d8ad3131f54"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a137560600851eb4c3e4b80e25d4da629"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</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">&#160;</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">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="inherited" name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pub_types_classwinstd_1_1handle"><td colspan="2" onclick="javascript:toggleInherit('pub_types_classwinstd_1_1handle')"><img src="closed.png" alt="-"/>&#160;Public Types inherited from <a class="el" href="classwinstd_1_1handle.html">winstd::handle&lt; HKEY, NULL &gt;</a></td></tr>
<tr class="memitem:a3dda19199ecfbc378c932e7d84d0ea81 inherit pub_types_classwinstd_1_1handle"><td class="memItemLeft" align="right" valign="top"><a id="a3dda19199ecfbc378c932e7d84d0ea81" name="a3dda19199ecfbc378c932e7d84d0ea81"></a>
typedef HKEY&#160;</td><td class="memItemRight" valign="bottom"><b>handle_type</b></td></tr>
<tr class="memdesc:a3dda19199ecfbc378c932e7d84d0ea81 inherit pub_types_classwinstd_1_1handle"><td class="mdescLeft">&#160;</td><td class="mdescRight">Datatype of the object handle this template class handles. <br /></td></tr>
<tr class="separator:a3dda19199ecfbc378c932e7d84d0ea81 inherit pub_types_classwinstd_1_1handle"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_static_attribs_classwinstd_1_1handle"><td colspan="2" onclick="javascript:toggleInherit('pub_static_attribs_classwinstd_1_1handle')"><img src="closed.png" alt="-"/>&#160;Static Public Attributes inherited from <a class="el" href="classwinstd_1_1handle.html">winstd::handle&lt; HKEY, NULL &gt;</a></td></tr>
<tr class="memitem:gacf43e306968474166474090690857e1c inherit pub_static_attribs_classwinstd_1_1handle"><td class="memItemLeft" align="right" valign="top"><a id="gacf43e306968474166474090690857e1c" name="gacf43e306968474166474090690857e1c"></a>
static const HKEY&#160;</td><td class="memItemRight" valign="bottom"><b>invalid</b></td></tr>
<tr class="memdesc:gacf43e306968474166474090690857e1c inherit pub_static_attribs_classwinstd_1_1handle"><td class="mdescLeft">&#160;</td><td class="mdescRight">Invalid handle value. <br /></td></tr>
<tr class="separator:gacf43e306968474166474090690857e1c inherit pub_static_attribs_classwinstd_1_1handle"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pro_attribs_classwinstd_1_1handle"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_classwinstd_1_1handle')"><img src="closed.png" alt="-"/>&#160;Protected Attributes inherited from <a class="el" href="classwinstd_1_1handle.html">winstd::handle&lt; HKEY, NULL &gt;</a></td></tr>
<tr class="memitem:aabde3f16fd98b06b3b0282ef7806eb59 inherit pro_attribs_classwinstd_1_1handle"><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>&#160;</td><td class="memItemRight" valign="bottom"><b>m_h</b></td></tr>
<tr class="memdesc:aabde3f16fd98b06b3b0282ef7806eb59 inherit pro_attribs_classwinstd_1_1handle"><td class="mdescLeft">&#160;</td><td class="mdescRight">Object handle. <br /></td></tr>
<tr class="separator:aabde3f16fd98b06b3b0282ef7806eb59 inherit pro_attribs_classwinstd_1_1handle"><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 >Registry wrapper class. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="ae54556effe6fe91942f87fc8c8ff5d7c" name="ae54556effe6fe91942f87fc8c8ff5d7c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae54556effe6fe91942f87fc8c8ff5d7c">&#9670;&nbsp;</a></span>~reg_key()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual winstd::reg_key::~reg_key </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 class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Closes a handle to the registry key. </p>
<dl class="section see"><dt>See also</dt><dd><a href="https://msdn.microsoft.com/en-us/library/windows/desktop/ms724837.aspx">RegCloseKey function</a> </dd></dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a63252cffe53e75e84894ee5567eb5c53" name="a63252cffe53e75e84894ee5567eb5c53"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a63252cffe53e75e84894ee5567eb5c53">&#9670;&nbsp;</a></span>create()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool winstd::reg_key::create </td>
<td>(</td>
<td class="paramtype">_In_ HKEY&#160;</td>
<td class="paramname"><em>hKey</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">_In_z_ LPCTSTR&#160;</td>
<td class="paramname"><em>lpSubKey</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">_In_opt_ LPTSTR&#160;</td>
<td class="paramname"><em>lpClass</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">_In_ DWORD&#160;</td>
<td class="paramname"><em>dwOptions</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">_In_ REGSAM&#160;</td>
<td class="paramname"><em>samDesired</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">_In_opt_ LPSECURITY_ATTRIBUTES&#160;</td>
<td class="paramname"><em>lpSecurityAttributes</em> = <code>NULL</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">_Out_opt_ LPDWORD&#160;</td>
<td class="paramname"><em>lpdwDisposition</em> = <code>NULL</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</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>Creates the specified registry key. If the key already exists, the function opens it. </p>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>true when creation succeeds;</li>
<li>false when creation fails. For extended error information, call <code>GetLastError()</code>.</li>
</ul>
</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a href="https://msdn.microsoft.com/en-us/library/windows/desktop/ms724844.aspx">RegCreateKeyEx function</a> </dd></dl>
</div>
</div>
<a id="a383dc95733bec990eae644ad6fcb8b4c" name="a383dc95733bec990eae644ad6fcb8b4c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a383dc95733bec990eae644ad6fcb8b4c">&#9670;&nbsp;</a></span>delete_subkey()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool winstd::reg_key::delete_subkey </td>
<td>(</td>
<td class="paramtype">_In_z_ LPCTSTR&#160;</td>
<td class="paramname"><em>szSubkey</em></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>Deletes the specified registry subkey. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">szSubkey</td><td>Name of the subkey to delete</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>true when creation succeeds;</li>
<li>false when creation fails. For extended error information, call <code>GetLastError()</code>. </li>
</ul>
</dd></dl>
</div>
</div>
<a id="a3dba00d2105a1c633c571d8ad3131f54" name="a3dba00d2105a1c633c571d8ad3131f54"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3dba00d2105a1c633c571d8ad3131f54">&#9670;&nbsp;</a></span>free_internal()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void winstd::reg_key::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">inline</span><span class="mlabel">override</span><span class="mlabel">protected</span><span class="mlabel">virtual</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Closes a handle to the registry key. </p>
<dl class="section see"><dt>See also</dt><dd><a href="https://msdn.microsoft.com/en-us/library/windows/desktop/ms724837.aspx">RegCloseKey function</a> </dd></dl>
<p>Implements <a class="el" href="classwinstd_1_1handle.html#a137560600851eb4c3e4b80e25d4da629">winstd::handle&lt; HKEY, NULL &gt;</a>.</p>
</div>
</div>
<a id="a1f6008b49c2a450dfdfecf204a8eab0f" name="a1f6008b49c2a450dfdfecf204a8eab0f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1f6008b49c2a450dfdfecf204a8eab0f">&#9670;&nbsp;</a></span>open()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool winstd::reg_key::open </td>
<td>(</td>
<td class="paramtype">_In_ HKEY&#160;</td>
<td class="paramname"><em>hKey</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">_In_opt_z_ LPCTSTR&#160;</td>
<td class="paramname"><em>lpSubKey</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">_In_ DWORD&#160;</td>
<td class="paramname"><em>ulOptions</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">_In_ REGSAM&#160;</td>
<td class="paramname"><em>samDesired</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</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>Opens the specified registry key. </p>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>true when creation succeeds;</li>
<li>false when creation fails. For extended error information, call <code>GetLastError()</code>.</li>
</ul>
</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a href="https://msdn.microsoft.com/en-us/library/windows/desktop/ms724897.aspx">RegOpenKeyEx 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 Fri Feb 4 2022 12:49: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.9.3
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink