<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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=9"/>
<meta name="generator" content="Doxygen 1.8.4"/>
<title>ClanLib: registry_key.h Source File</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="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 style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">ClanLib
 <span id="projectnumber">2.3.7</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.4 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>File Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_14852d208b69b5a1926f5d908b4903da.html">Sources</a></li><li class="navelem"><a class="el" href="dir_66cde9167ab84f7398e86467706d8b82.html">API</a></li><li class="navelem"><a class="el" href="dir_e102932cffc31fbd234362e82383ea76.html">Core</a></li><li class="navelem"><a class="el" href="dir_9ffdfbd194a1140571e48ea045c76d46.html">System</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">registry_key.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="registry__key_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">** ClanLib SDK</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">** Copyright (c) 1997-2011 The ClanLib Team</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">**</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment">** This software is provided 'as-is', without any express or implied</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment">** warranty. In no event will the authors be held liable for any damages</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">** arising from the use of this software.</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment">**</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment">** Permission is granted to anyone to use this software for any purpose,</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment">** including commercial applications, and to alter it and redistribute it</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment">** freely, subject to the following restrictions:</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment">**</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment">** 1. The origin of this software must not be misrepresented; you must not</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment">** claim that you wrote the original software. If you use this software</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment">** in a product, an acknowledgment in the product documentation would be</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment">** appreciated but is not required.</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment">** 2. Altered source versions must be plainly marked as such, and must not be</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment">** misrepresented as being the original software.</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment">** 3. This notice may not be removed or altered from any source distribution.</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment">**</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment">** Note: Some of the libraries ClanLib may link to may have additional</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment">** requirements or restrictions.</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment">**</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment">** File Author(s):</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment">**</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment">** Magnus Norddahl</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment">*/</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> </div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> </div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> </div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="preprocessor">#pragma once</span></div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="preprocessor">#ifdef WIN32</span></div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="preprocessor">#include "../api_core.h"</span></div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="preprocessor">#include "<a class="code" href="databuffer_8h.html">databuffer.h</a>"</span></div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="preprocessor">#include <vector></span></div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> </div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="keyword">class </span>CL_RegistryKey_Impl;</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> </div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> </div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="keyword">class </span><a class="code" href="api__core_8h.html#acd328839faa5ca4b339ea3a48ba6edcf">CL_API_CORE</a> CL_RegistryKey</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> {</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> </div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="keyword">public</span>:</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="keyword">enum</span> PredefinedKey</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  {</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  key_classes_root,</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  key_current_config,</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  key_current_user,</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  key_local_machine,</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  key_users</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  };</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> </div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <span class="keyword">enum</span> CreateFlags</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  {</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  create_always = 0,</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  create_new = 1,</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  create_volatile = 2</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  };</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> </div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <span class="comment">// Construct a null instance</span></div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  CL_RegistryKey();</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span> </div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  CL_RegistryKey(PredefinedKey key, <span class="keyword">const</span> <a class="code" href="classCL__StringRef8.html" title="String reference template. ">CL_StringRef</a> &subkey, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> access_rights = KEY_ALL_ACCESS, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> create_flags = create_always);</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span> </div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  CL_RegistryKey(HKEY key);</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span> </div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  ~CL_RegistryKey();</div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span> </div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span> </div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span> </div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="keyword">public</span>:</div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <span class="keywordtype">bool</span> is_null()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> !impl; }</div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span> </div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  <span class="keywordtype">void</span> throw_if_null() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span> </div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  HKEY get_key() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span> </div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  std::vector<CL_String> get_subkey_names() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span> </div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  std::vector<CL_String> get_value_names() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span> </div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  <span class="keywordtype">int</span> get_value_int(<span class="keyword">const</span> <a class="code" href="classCL__StringRef8.html" title="String reference template. ">CL_StringRef</a> &name, <span class="keywordtype">int</span> default_value = 0) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span> </div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  <a class="code" href="classCL__DataBuffer.html" title="General purpose data buffer. ">CL_DataBuffer</a> get_value_binary(<span class="keyword">const</span> <a class="code" href="classCL__StringRef8.html" title="String reference template. ">CL_StringRef</a> &name, <span class="keyword">const</span> <a class="code" href="classCL__DataBuffer.html" title="General purpose data buffer. ">CL_DataBuffer</a> &default_value = <a class="code" href="classCL__DataBuffer.html" title="General purpose data buffer. ">CL_DataBuffer</a>()) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span> </div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  <a class="code" href="classCL__String8.html" title="String container template. ">CL_String</a> get_value_string(<span class="keyword">const</span> <a class="code" href="classCL__StringRef8.html" title="String reference template. ">CL_StringRef</a> &name, <span class="keyword">const</span> <a class="code" href="classCL__StringRef8.html" title="String reference template. ">CL_StringRef</a> &default_value = <a class="code" href="group__clanCore__Text.html#ga8b087e7abbccbe1f6fa3adf97fca3959">CL_StringRef</a>()) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span> </div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  std::vector<CL_String> get_value_multi_string(<span class="keyword">const</span> <a class="code" href="classCL__StringRef8.html" title="String reference template. ">CL_StringRef</a> &name, <span class="keyword">const</span> std::vector<CL_String> &default_value = std::vector<CL_String>()) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span> </div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span> </div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span> </div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span> <span class="keyword">public</span>:</div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  CL_RegistryKey open_key(<span class="keyword">const</span> <a class="code" href="classCL__StringRef8.html" title="String reference template. ">CL_StringRef</a> &subkey, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> access_rights = KEY_ALL_ACCESS);</div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span> </div>
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  CL_RegistryKey create_key(<span class="keyword">const</span> <a class="code" href="classCL__StringRef8.html" title="String reference template. ">CL_StringRef</a> &subkey, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> access_rights = KEY_ALL_ACCESS, CreateFlags create_flags = create_always);</div>
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span> </div>
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  <span class="keywordtype">void</span> delete_key(<span class="keyword">const</span> <a class="code" href="classCL__StringRef8.html" title="String reference template. ">CL_StringRef</a> &subkey, <span class="keywordtype">bool</span> recursive);</div>
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span> </div>
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  <span class="keyword">static</span> <span class="keywordtype">void</span> delete_key(PredefinedKey key, <span class="keyword">const</span> <a class="code" href="classCL__StringRef8.html" title="String reference template. ">CL_StringRef</a> &subkey, <span class="keywordtype">bool</span> recursive);</div>
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span> </div>
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span>  <span class="keywordtype">void</span> set_value_int(<span class="keyword">const</span> <a class="code" href="classCL__StringRef8.html" title="String reference template. ">CL_StringRef</a> &name, <span class="keywordtype">int</span> value);</div>
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span> </div>
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span>  <span class="keywordtype">void</span> set_value_binary(<span class="keyword">const</span> <a class="code" href="classCL__StringRef8.html" title="String reference template. ">CL_StringRef</a> &name, <span class="keyword">const</span> <a class="code" href="classCL__DataBuffer.html" title="General purpose data buffer. ">CL_DataBuffer</a> &value);</div>
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span> </div>
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span>  <span class="keywordtype">void</span> set_value_string(<span class="keyword">const</span> <a class="code" href="classCL__StringRef8.html" title="String reference template. ">CL_StringRef</a> &name, <span class="keyword">const</span> <a class="code" href="classCL__StringRef8.html" title="String reference template. ">CL_StringRef</a> &value);</div>
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span> </div>
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span> <span class="comment">// void set_value_multi_string(const CL_StringRef &name, const std::vector<CL_String> &value);</span></div>
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span> </div>
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span>  <span class="keywordtype">void</span> delete_value(<span class="keyword">const</span> <a class="code" href="classCL__StringRef8.html" title="String reference template. ">CL_StringRef</a> &name);</div>
<div class="line"><a name="l00126"></a><span class="lineno"> 126</span> </div>
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span> </div>
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span> </div>
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span> <span class="keyword">private</span>:</div>
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span>  CL_SharedPtr<CL_RegistryKey_Impl> impl;</div>
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span> };</div>
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span> </div>
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span> <span class="preprocessor"></span></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Jun 14 2013 13:05:46 for ClanLib by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.4
</small></address>
</body>
</html>
