Sophie

Sophie

distrib > Mandriva > 2008.1 > x86_64 > media > main-testing > by-pkgid > 2c50825dd66d0497b96a67f7fab2ee84 > files > 8260

openoffice.org64-devel-doc-2.4.1.10-1mdv2008.1.x86_64.rpm

<html>
<head>
<title>Methods of Class Registry</title>
<link rel="stylesheet" type="text/css" href="../../cpp.css">
</head>
<body>
<div id="adc-cppref">

<a name="_top_"> </a><table class="navimain" border="0" cellpadding="1" cellspacing="0">
<tr align="center" valign="top">
<td class="navimain">&nbsp;<a href="../../index.html">Overview</a>&nbsp;</td>
<td class="navimain">&nbsp;<a href="../index.html">Namespace</a>&nbsp;</td>
<td class="navimain">&nbsp;<a href="../c-Registry.html">Class</a>&nbsp;</td>
<td class="navimain">&nbsp;<a href="../../index-files/index-1.html">Index</a>&nbsp;</td>
<td class="navimain">&nbsp;<a href="../../help.html">Help</a>&nbsp;</td>
</tr>
</table>
<table class="navisub" cellpadding="0" cellspacing="3"></table>
<hr>
<div class="title"><h2>Methods of Class Registry</h2>
</div><hr>
<dl class="member">
<dt class="member"><a name="Registry-2173"> </a>Registry</dt>
<dd class="member"><dl>
<dt class="simple"> <strong>Registry</strong>();</dt>
<dd><table class="param-table"></table>
</dd>
</dl>
<br>
</dd>
<dd class="member"><table class="flag-table" border="1" cellspacing="0">
<tr>
<td width="12%" class="flagname">virtual</td>
<td width="12%" class="flagname">abstract</td>
<td width="12%" class="flagname">const</td>
<td width="12%" class="flagname">volatile</td>
<td width="12%" class="flagname">template</td>
<td width="12%" class="flagname">static</td>
<td width="12%" class="flagname">inline</td>
<td width="12%" class="flagname">C-linkage</td>
</tr>
<tr>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagyes">YES</td>
<td class="flagno">NO</td>
</tr>
</table>
<br>
</dd>
<dd class="member"><dl>
<dt>Summary</dt>
<dd>Default constructor.
</dd>
</dl>
</dd>
</dl>
<hr>
<dl class="member">
<dt class="member"><a name="Registry-2174"> </a>Registry</dt>
<dd class="member"><dl>
<dt class="simple"> <strong>Registry</strong>(</dt>
<dd><table class="param-table">
<tr>
<td>const <a href="../c-Registry.html">Registry</a> &amp; </td>
<td> toCopy );</td>
</tr>
</table>
</dd>
</dl>
<br>
</dd>
<dd class="member"><table class="flag-table" border="1" cellspacing="0">
<tr>
<td width="12%" class="flagname">virtual</td>
<td width="12%" class="flagname">abstract</td>
<td width="12%" class="flagname">const</td>
<td width="12%" class="flagname">volatile</td>
<td width="12%" class="flagname">template</td>
<td width="12%" class="flagname">static</td>
<td width="12%" class="flagname">inline</td>
<td width="12%" class="flagname">C-linkage</td>
</tr>
<tr>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagyes">YES</td>
<td class="flagno">NO</td>
</tr>
</table>
<br>
</dd>
<dd class="member"><dl>
<dt>Summary</dt>
<dd>Copy constructcor</dd>
</dl>
</dd>
</dl>
<hr>
<dl class="member">
<dt class="member"><a name="~Registry-2175"> </a>~Registry</dt>
<dd class="member"><dl>
<dt class="simple"> <strong>~Registry</strong>();</dt>
<dd><table class="param-table"></table>
</dd>
</dl>
<br>
</dd>
<dd class="member"><table class="flag-table" border="1" cellspacing="0">
<tr>
<td width="12%" class="flagname">virtual</td>
<td width="12%" class="flagname">abstract</td>
<td width="12%" class="flagname">const</td>
<td width="12%" class="flagname">volatile</td>
<td width="12%" class="flagname">template</td>
<td width="12%" class="flagname">static</td>
<td width="12%" class="flagname">inline</td>
<td width="12%" class="flagname">C-linkage</td>
</tr>
<tr>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagyes">YES</td>
<td class="flagno">NO</td>
</tr>
</table>
<br>
</dd>
<dd class="member"><dl>
<dt>Summary</dt>
<dd>Destructor. The Destructor close the registry if it is open.</dd>
</dl>
</dd>
</dl>
<hr>
<dl class="member">
<dt class="member"><a name="operator=-2176"> </a>operator=</dt>
<dd class="member"><dl>
<dt class="simple"><a href="../c-Registry.html">Registry</a> &amp; <strong>operator=</strong>(</dt>
<dd><table class="param-table">
<tr>
<td>const <a href="../c-Registry.html">Registry</a> &amp; </td>
<td> toAssign );</td>
</tr>
</table>
</dd>
</dl>
<br>
</dd>
<dd class="member"><table class="flag-table" border="1" cellspacing="0">
<tr>
<td width="12%" class="flagname">virtual</td>
<td width="12%" class="flagname">abstract</td>
<td width="12%" class="flagname">const</td>
<td width="12%" class="flagname">volatile</td>
<td width="12%" class="flagname">template</td>
<td width="12%" class="flagname">static</td>
<td width="12%" class="flagname">inline</td>
<td width="12%" class="flagname">C-linkage</td>
</tr>
<tr>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagyes">YES</td>
<td class="flagno">NO</td>
</tr>
</table>
<br>
</dd>
<dd class="member"><dl>
<dt>Summary</dt>
<dd>Assign operator</dd>
</dl>
</dd>
</dl>
<hr>
<dl class="member">
<dt class="member"><a name="isValid-2177"> </a>isValid</dt>
<dd class="member"><dl>
<dt class="simple"><a href="../t-sal_Bool.html">sal_Bool</a> <strong>isValid</strong>();</dt>
<dd><table class="param-table"></table>
</dd>
</dl>
<br>
</dd>
<dd class="member"><table class="flag-table" border="1" cellspacing="0">
<tr>
<td width="12%" class="flagname">virtual</td>
<td width="12%" class="flagname">abstract</td>
<td width="12%" class="flagname">const</td>
<td width="12%" class="flagname">volatile</td>
<td width="12%" class="flagname">template</td>
<td width="12%" class="flagname">static</td>
<td width="12%" class="flagname">inline</td>
<td width="12%" class="flagname">C-linkage</td>
</tr>
<tr>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagyes">YES</td>
<td class="flagno">NO</td>
</tr>
</table>
<br>
</dd>
<dd class="member"><dl>
<dt>Summary</dt>
<dd>checks if the registry points to a valid registry data file.</dd>
</dl>
</dd>
</dl>
<hr>
<dl class="member">
<dt class="member"><a name="isReadOnly-2178"> </a>isReadOnly</dt>
<dd class="member"><dl>
<dt class="simple"><a href="../t-sal_Bool.html">sal_Bool</a> <strong>isReadOnly</strong>();</dt>
<dd><table class="param-table"></table>
</dd>
</dl>
<br>
</dd>
<dd class="member"><table class="flag-table" border="1" cellspacing="0">
<tr>
<td width="12%" class="flagname">virtual</td>
<td width="12%" class="flagname">abstract</td>
<td width="12%" class="flagname">const</td>
<td width="12%" class="flagname">volatile</td>
<td width="12%" class="flagname">template</td>
<td width="12%" class="flagname">static</td>
<td width="12%" class="flagname">inline</td>
<td width="12%" class="flagname">C-linkage</td>
</tr>
<tr>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagyes">YES</td>
<td class="flagno">NO</td>
</tr>
</table>
<br>
</dd>
<dd class="member"><dl>
<dt>Summary</dt>
<dd>returns the access mode of the registry.

</dd>
<dt>Return</dt>
<dd>TRUE if the access mode is readonly else FALSE. 
</dd>
</dl>
</dd>
</dl>
<hr>
<dl class="member">
<dt class="member"><a name="openRootKey-2179"> </a>openRootKey</dt>
<dd class="member"><dl>
<dt class="simple"><a href="../e-RegError.html">RegError</a> <strong>openRootKey</strong>(</dt>
<dd><table class="param-table">
<tr>
<td><a href="../c-RegistryKey.html">RegistryKey</a> &amp; </td>
<td> rRootKey );</td>
</tr>
</table>
</dd>
</dl>
<br>
</dd>
<dd class="member"><table class="flag-table" border="1" cellspacing="0">
<tr>
<td width="12%" class="flagname">virtual</td>
<td width="12%" class="flagname">abstract</td>
<td width="12%" class="flagname">const</td>
<td width="12%" class="flagname">volatile</td>
<td width="12%" class="flagname">template</td>
<td width="12%" class="flagname">static</td>
<td width="12%" class="flagname">inline</td>
<td width="12%" class="flagname">C-linkage</td>
</tr>
<tr>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagyes">YES</td>
<td class="flagno">NO</td>
</tr>
</table>
<br>
</dd>
<dd class="member"><dl>
<dt>Summary</dt>
<dd>opens the root key of the registry.

</dd>
<dt>Parameters</dt>
<dd><table border="0" width="100%" cellpadding="3" cellspacing="0" class="expl-table">
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">rRootKey</td>
<td><pre>reference to a RegistryKey which is filled with the rootkey.
</pre></td>
</tr>
</table>
</dd>
<dt>Return</dt>
<dd>REG_NO_ERROR if succeeds else an error code. 
</dd>
</dl>
</dd>
</dl>
<hr>
<dl class="member">
<dt class="member"><a name="getName-2180"> </a>getName</dt>
<dd class="member"><dl>
<dt class="simple">::rtl::<a href="../rtl/c-OUString.html">OUString</a> <strong>getName</strong>();</dt>
<dd><table class="param-table"></table>
</dd>
</dl>
<br>
</dd>
<dd class="member"><table class="flag-table" border="1" cellspacing="0">
<tr>
<td width="12%" class="flagname">virtual</td>
<td width="12%" class="flagname">abstract</td>
<td width="12%" class="flagname">const</td>
<td width="12%" class="flagname">volatile</td>
<td width="12%" class="flagname">template</td>
<td width="12%" class="flagname">static</td>
<td width="12%" class="flagname">inline</td>
<td width="12%" class="flagname">C-linkage</td>
</tr>
<tr>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagyes">YES</td>
<td class="flagno">NO</td>
</tr>
</table>
<br>
</dd>
<dd class="member"><dl>
<dt>Summary</dt>
<dd>returns the name of the current registry data file.</dd>
</dl>
</dd>
</dl>
<hr>
<dl class="member">
<dt class="member"><a name="create-2181"> </a>create</dt>
<dd class="member"><dl>
<dt class="simple"><a href="../e-RegError.html">RegError</a> <strong>create</strong>(</dt>
<dd><table class="param-table">
<tr>
<td>const ::rtl::<a href="../rtl/c-OUString.html">OUString</a> &amp; </td>
<td> registryName );</td>
</tr>
</table>
</dd>
</dl>
<br>
</dd>
<dd class="member"><table class="flag-table" border="1" cellspacing="0">
<tr>
<td width="12%" class="flagname">virtual</td>
<td width="12%" class="flagname">abstract</td>
<td width="12%" class="flagname">const</td>
<td width="12%" class="flagname">volatile</td>
<td width="12%" class="flagname">template</td>
<td width="12%" class="flagname">static</td>
<td width="12%" class="flagname">inline</td>
<td width="12%" class="flagname">C-linkage</td>
</tr>
<tr>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagyes">YES</td>
<td class="flagno">NO</td>
</tr>
</table>
<br>
</dd>
<dd class="member"><dl>
<dt>Summary</dt>
<dd>creates a new registry with the specified name and creates a root key.

</dd>
<dt>Parameters</dt>
<dd><table border="0" width="100%" cellpadding="3" cellspacing="0" class="expl-table">
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">registryName</td>
<td><pre>specifies the name of the new registry.
</pre></td>
</tr>
</table>
</dd>
<dt>Return</dt>
<dd>REG_NO_ERROR if succeeds else an error code. 
</dd>
</dl>
</dd>
</dl>
<hr>
<dl class="member">
<dt class="member"><a name="open-2182"> </a>open</dt>
<dd class="member"><dl>
<dt class="simple"><a href="../e-RegError.html">RegError</a> <strong>open</strong>(</dt>
<dd><table class="param-table">
<tr>
<td>const ::rtl::<a href="../rtl/c-OUString.html">OUString</a> &amp; </td>
<td> registryName,</td>
</tr>
<tr>
<td><a href="../t-RegAccessMode.html">RegAccessMode</a></td>
<td>accessMode );</td>
</tr>
</table>
</dd>
</dl>
<br>
</dd>
<dd class="member"><table class="flag-table" border="1" cellspacing="0">
<tr>
<td width="12%" class="flagname">virtual</td>
<td width="12%" class="flagname">abstract</td>
<td width="12%" class="flagname">const</td>
<td width="12%" class="flagname">volatile</td>
<td width="12%" class="flagname">template</td>
<td width="12%" class="flagname">static</td>
<td width="12%" class="flagname">inline</td>
<td width="12%" class="flagname">C-linkage</td>
</tr>
<tr>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagyes">YES</td>
<td class="flagno">NO</td>
</tr>
</table>
<br>
</dd>
<dd class="member"><dl>
<dt>Summary</dt>
<dd>opens a registry with the specified name.

</dd>
<dt>Description</dt>
<dd>If the registry already points to a valid registry, the old registry will be closed.
</dd>
<dt>Parameters</dt>
<dd><table border="0" width="100%" cellpadding="3" cellspacing="0" class="expl-table">
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">registryName</td>
<td><pre>specifies a registry name.
</pre></td>
</tr>
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">accessMode</td>
<td><pre>specifies the access mode for the registry, REG_READONLY or REG_READWRITE.
</pre></td>
</tr>
</table>
</dd>
<dt>Return</dt>
<dd>REG_NO_ERROR if succeeds else an error code. 
</dd>
</dl>
</dd>
</dl>
<hr>
<dl class="member">
<dt class="member"><a name="close-2183"> </a>close</dt>
<dd class="member"><dl>
<dt class="simple"><a href="../e-RegError.html">RegError</a> <strong>close</strong>();</dt>
<dd><table class="param-table"></table>
</dd>
</dl>
<br>
</dd>
<dd class="member"><table class="flag-table" border="1" cellspacing="0">
<tr>
<td width="12%" class="flagname">virtual</td>
<td width="12%" class="flagname">abstract</td>
<td width="12%" class="flagname">const</td>
<td width="12%" class="flagname">volatile</td>
<td width="12%" class="flagname">template</td>
<td width="12%" class="flagname">static</td>
<td width="12%" class="flagname">inline</td>
<td width="12%" class="flagname">C-linkage</td>
</tr>
<tr>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagyes">YES</td>
<td class="flagno">NO</td>
</tr>
</table>
<br>
</dd>
<dd class="member"><dl>
<dt>Summary</dt>
<dd>closes explicitly the current registry data file.</dd>
</dl>
</dd>
</dl>
<hr>
<dl class="member">
<dt class="member"><a name="destroy-2184"> </a>destroy</dt>
<dd class="member"><dl>
<dt class="simple"><a href="../e-RegError.html">RegError</a> <strong>destroy</strong>(</dt>
<dd><table class="param-table">
<tr>
<td>const ::rtl::<a href="../rtl/c-OUString.html">OUString</a> &amp; </td>
<td> registryName );</td>
</tr>
</table>
</dd>
</dl>
<br>
</dd>
<dd class="member"><table class="flag-table" border="1" cellspacing="0">
<tr>
<td width="12%" class="flagname">virtual</td>
<td width="12%" class="flagname">abstract</td>
<td width="12%" class="flagname">const</td>
<td width="12%" class="flagname">volatile</td>
<td width="12%" class="flagname">template</td>
<td width="12%" class="flagname">static</td>
<td width="12%" class="flagname">inline</td>
<td width="12%" class="flagname">C-linkage</td>
</tr>
<tr>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagyes">YES</td>
<td class="flagno">NO</td>
</tr>
</table>
<br>
</dd>
<dd class="member"><dl>
<dt>Summary</dt>
<dd>destroys a registry.

</dd>
<dt>Parameters</dt>
<dd><table border="0" width="100%" cellpadding="3" cellspacing="0" class="expl-table">
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">registryName</td>
<td><pre>specifies a registry name, if the name is an empty string the registry
                    itselfs will be destroyed.
</pre></td>
</tr>
</table>
</dd>
<dt>Return</dt>
<dd>REG_NO_ERROR if succeeds else an error code. 
</dd>
</dl>
</dd>
</dl>
<hr>
<dl class="member">
<dt class="member"><a name="loadKey-2185"> </a>loadKey</dt>
<dd class="member"><dl>
<dt class="simple"><a href="../e-RegError.html">RegError</a> <strong>loadKey</strong>(</dt>
<dd><table class="param-table">
<tr>
<td><a href="../c-RegistryKey.html">RegistryKey</a> &amp; </td>
<td> rKey,</td>
</tr>
<tr>
<td>const ::rtl::<a href="../rtl/c-OUString.html">OUString</a> &amp;</td>
<td>keyName,</td>
</tr>
<tr>
<td>const ::rtl::<a href="../rtl/c-OUString.html">OUString</a> &amp;</td>
<td>regFileName );</td>
</tr>
</table>
</dd>
</dl>
<br>
</dd>
<dd class="member"><table class="flag-table" border="1" cellspacing="0">
<tr>
<td width="12%" class="flagname">virtual</td>
<td width="12%" class="flagname">abstract</td>
<td width="12%" class="flagname">const</td>
<td width="12%" class="flagname">volatile</td>
<td width="12%" class="flagname">template</td>
<td width="12%" class="flagname">static</td>
<td width="12%" class="flagname">inline</td>
<td width="12%" class="flagname">C-linkage</td>
</tr>
<tr>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagyes">YES</td>
<td class="flagno">NO</td>
</tr>
</table>
<br>
</dd>
<dd class="member"><dl>
<dt>Summary</dt>
<dd>loads registry information from a specified file and save it under the 
specified keyName.

</dd>
<dt>Parameters</dt>
<dd><table border="0" width="100%" cellpadding="3" cellspacing="0" class="expl-table">
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">rKey</td>
<td><pre>references a currently open key. The key which should store the registry information
             is a subkey of this key.
</pre></td>
</tr>
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">keyName</td>
<td><pre>specifies the name of the key which stores the registry information. If keyName is
                is an empty string the registry information will be saved under the key specified
                by rKey.
</pre></td>
</tr>
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">regFileName</td>
<td><pre>specifies the file containing the registry information.
</pre></td>
</tr>
</table>
</dd>
<dt>Return</dt>
<dd>REG_NO_ERROR if succeeds else an error code. 
</dd>
</dl>
</dd>
</dl>
<hr>
<dl class="member">
<dt class="member"><a name="saveKey-2186"> </a>saveKey</dt>
<dd class="member"><dl>
<dt class="simple"><a href="../e-RegError.html">RegError</a> <strong>saveKey</strong>(</dt>
<dd><table class="param-table">
<tr>
<td><a href="../c-RegistryKey.html">RegistryKey</a> &amp; </td>
<td> rKey,</td>
</tr>
<tr>
<td>const ::rtl::<a href="../rtl/c-OUString.html">OUString</a> &amp;</td>
<td>keyName,</td>
</tr>
<tr>
<td>const ::rtl::<a href="../rtl/c-OUString.html">OUString</a> &amp;</td>
<td>regFileName );</td>
</tr>
</table>
</dd>
</dl>
<br>
</dd>
<dd class="member"><table class="flag-table" border="1" cellspacing="0">
<tr>
<td width="12%" class="flagname">virtual</td>
<td width="12%" class="flagname">abstract</td>
<td width="12%" class="flagname">const</td>
<td width="12%" class="flagname">volatile</td>
<td width="12%" class="flagname">template</td>
<td width="12%" class="flagname">static</td>
<td width="12%" class="flagname">inline</td>
<td width="12%" class="flagname">C-linkage</td>
</tr>
<tr>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagyes">YES</td>
<td class="flagno">NO</td>
</tr>
</table>
<br>
</dd>
<dd class="member"><dl>
<dt>Summary</dt>
<dd>saves the registry information of the specified key and all subkeys and save 
it in the specified file.

</dd>
<dt>Parameters</dt>
<dd><table border="0" width="100%" cellpadding="3" cellspacing="0" class="expl-table">
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">rKey</td>
<td><pre>references a currently open key. The key which information is saved by this
             function is a subkey of this key.
</pre></td>
</tr>
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">keyName</td>
<td><pre>specifies the name of the key which information should be stored.
                If keyName is an empty string the registry information under the key specified
                by rKey is saved in the specified file.
</pre></td>
</tr>
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">regFileName</td>
<td><pre>specifies the file containing the registry information.
</pre></td>
</tr>
</table>
</dd>
<dt>Return</dt>
<dd>REG_NO_ERROR if succeeds else an error code. 
</dd>
</dl>
</dd>
</dl>
<hr>
<dl class="member">
<dt class="member"><a name="mergeKey-2187"> </a>mergeKey</dt>
<dd class="member"><dl>
<dt class="simple"><a href="../e-RegError.html">RegError</a> <strong>mergeKey</strong>(</dt>
<dd><table class="param-table">
<tr>
<td><a href="../c-RegistryKey.html">RegistryKey</a> &amp; </td>
<td> rKey,</td>
</tr>
<tr>
<td>const ::rtl::<a href="../rtl/c-OUString.html">OUString</a> &amp;</td>
<td>keyName,</td>
</tr>
<tr>
<td>const ::rtl::<a href="../rtl/c-OUString.html">OUString</a> &amp;</td>
<td>regFileName,</td>
</tr>
<tr>
<td><a href="../t-sal_Bool.html">sal_Bool</a></td>
<td>bWarnings = sal_False,</td>
</tr>
<tr>
<td><a href="../t-sal_Bool.html">sal_Bool</a></td>
<td>bReport = sal_False );</td>
</tr>
</table>
</dd>
</dl>
<br>
</dd>
<dd class="member"><table class="flag-table" border="1" cellspacing="0">
<tr>
<td width="12%" class="flagname">virtual</td>
<td width="12%" class="flagname">abstract</td>
<td width="12%" class="flagname">const</td>
<td width="12%" class="flagname">volatile</td>
<td width="12%" class="flagname">template</td>
<td width="12%" class="flagname">static</td>
<td width="12%" class="flagname">inline</td>
<td width="12%" class="flagname">C-linkage</td>
</tr>
<tr>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagyes">YES</td>
<td class="flagno">NO</td>
</tr>
</table>
<br>
</dd>
<dd class="member"><dl>
<dt>Summary</dt>
<dd>merges the registry information of the specified key with the registry 
information of the specified file.

</dd>
<dt>Description</dt>
<dd>All existing keys will be extended and existing key values will be overwritten.
</dd>
<dt>Parameters</dt>
<dd><table border="0" width="100%" cellpadding="3" cellspacing="0" class="expl-table">
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">rKey</td>
<td><pre>references a currently open key. The key which information is merged by this
             function is a subkey of this key
</pre></td>
</tr>
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">keyName</td>
<td><pre>specifies the name of the key which will be merged.
                If keyName is an empty string the registry information under the key specified 
                by rKey is merged with the information from the specified file.
</pre></td>
</tr>
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">regFileName</td>
<td><pre>specifies the file containing the registry information.
</pre></td>
</tr>
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">bWarnings</td>
<td><pre>if TRUE the function returns an error if a key already exists. 
</pre></td>
</tr>
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">bReport</td>
<td><pre>if TRUE the function reports warnings on stdout if a key already exists. 
</pre></td>
</tr>
</table>
</dd>
<dt>Return</dt>
<dd>REG_NO_ERROR if succeeds else an error code. If it returns an error the registry will 
        restore the state before merging. 
</dd>
</dl>
</dd>
</dl>
<hr>
<dl class="member">
<dt class="member"><a name="dumpRegistry-2188"> </a>dumpRegistry</dt>
<dd class="member"><dl>
<dt class="simple"><a href="../e-RegError.html">RegError</a> <strong>dumpRegistry</strong>(</dt>
<dd><table class="param-table">
<tr>
<td><a href="../c-RegistryKey.html">RegistryKey</a> &amp; </td>
<td> rKey );</td>
</tr>
</table>
</dd>
</dl>
<br>
</dd>
<dd class="member"><table class="flag-table" border="1" cellspacing="0">
<tr>
<td width="12%" class="flagname">virtual</td>
<td width="12%" class="flagname">abstract</td>
<td width="12%" class="flagname">const</td>
<td width="12%" class="flagname">volatile</td>
<td width="12%" class="flagname">template</td>
<td width="12%" class="flagname">static</td>
<td width="12%" class="flagname">inline</td>
<td width="12%" class="flagname">C-linkage</td>
</tr>
<tr>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagyes">YES</td>
<td class="flagno">NO</td>
</tr>
</table>
<br>
</dd>
<dd class="member"><dl>
<dt>Summary</dt>
<dd>This function reports the complete registry information of a key and all of its subkeys.

</dd>
<dt>Description</dt>
<dd>All information which are available (keynames, value types, values, linknames, linktargets, ...)
will be printed to stdout for report issues only.
</dd>
<dt>Parameters</dt>
<dd><table border="0" width="100%" cellpadding="3" cellspacing="0" class="expl-table">
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">rKey</td>
<td><pre>references a currently open key which content will be reported.
</pre></td>
</tr>
</table>
</dd>
<dt>Return</dt>
<dd>REG_NO_ERROR if succeeds else an error code. 
</dd>
</dl>
</dd>
</dl>
<hr>
<dl class="member">
<dt class="member"><a name="getApi-2189"> </a>getApi</dt>
<dd class="member"><dl>
<dt class="simple">const <a href="../c-Registry_Api.html">Registry_Api</a> * <strong>getApi</strong>();</dt>
<dd><table class="param-table"></table>
</dd>
</dl>
<br>
</dd>
<dd class="member"><table class="flag-table" border="1" cellspacing="0">
<tr>
<td width="12%" class="flagname">virtual</td>
<td width="12%" class="flagname">abstract</td>
<td width="12%" class="flagname">const</td>
<td width="12%" class="flagname">volatile</td>
<td width="12%" class="flagname">template</td>
<td width="12%" class="flagname">static</td>
<td width="12%" class="flagname">inline</td>
<td width="12%" class="flagname">C-linkage</td>
</tr>
<tr>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagyes">YES</td>
<td class="flagno">NO</td>
</tr>
</table>
<br>
</dd>
<dd class="member"><dl>
<dt>Summary</dt>
<dd>returns the used registry Api.</dd>
</dl>
</dd>
</dl>
<hr>
<a href="#_top_" class="objchapter">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright &copy; 2008 Sun Microsystems, Inc.</p>

</div> <!-- id="adc-cppref" -->
</body>

</html>

Perl :: Catalyst :: PostgreSQL :: RPM Valid HTML 4.01 Transitional