blob: a478312525ac651f64848fe12479089338c25e0c [file] [log] [blame]
<html>
<head>
<title>class Registry</title>
<style> h1 { font-size:20pt; margin-top:3pt; margin-bottom:7pt; }
h2 { font-family:"Arial"; font-size:16pt; margin-top:3pt; margin-bottom:5pt; }
h3 { font-size:13pt; margin-top:2pt; margin-bottom:3pt; }
h4 { font-size:10pt; font-weight:bold; margin-top:2pt; margin-bottom:1pt; }
dl { margin-top:1pt; margin-bottom:1pt; }
dl.member { margin-top:1pt; margin-bottom:1pt; background-color:#eeeeff; }
dt { font-size:10pt; font-weight:bold; margin-top:2pt; margin-bottom:1pt; }
dt.member { font-size:13pt; font-weight:bold; margin-top:2pt; margin-bottom:1pt; }
dt.simple { font-size:10pt; font-weight:normal; margin-top:2pt; margin-bottom:1pt; }
dd { font-size:10pt; margin-top:1pt; margin-bottom:1pt; }
dd.member { font-size:10pt; margin-top:1pt; margin-bottom:1pt; background-color:#ffffff; }
p { font-size:10pt; margin-top:3pt; margin-bottom:1pt; }
pre { font-family: Times, serif; font-size:10pt; margin-top:1pt; margin-bottom:1pt; }
tr { font-size:10pt; }
td { font-size:10pt; }
</style>
<meta HTTP-EQUIV="content-type" CONTENT="text/html; charset=UTF-8">
</head>
<body bgcolor="#ffffff">
<a name="_top_"> </a>
<table border="0" cellpadding="1" cellspacing="0">
<tr align="center" valign="top">
<td bgcolor="#eeeeff">&nbsp;<a href="../index.html" alt><font family="Arial" color="#000000" size="+1"><b>Overview</b></font></a>&nbsp;</td>
<td bgcolor="#eeeeff">&nbsp;<a href="index.html" alt><font family="Arial" color="#000000" size="+1"><b>Namespace</b></font></a>&nbsp;</td>
<td bgcolor="#2222ad">&nbsp;<font family="Arial" color="#ffffff" size="+1"><b>Class</b></font>&nbsp;</td>
<td bgcolor="#eeeeff">&nbsp;<a href="../index-files/index-1.html" alt><font family="Arial" color="#000000" size="+1"><b>Index</b></font></a>&nbsp;</td>
<td bgcolor="#eeeeff">&nbsp;<a href="../help.html" alt><font family="Arial" color="#000000" size="+1"><b>Help</b></font></a>&nbsp;</td>
</tr>
</table>
<table cellpadding="0" cellspacing="3">
<tr>
<td width="20%"><font size="-2">PUBLIC MEMBERS:</font></td>
<td>
&nbsp;<font size="-2">CLASSES</font>
|&nbsp;<font size="-2">STRUCTS</font>
|&nbsp;<font size="-2">UNIONS</font>
|&nbsp;<font size="-2">ENUMS</font>
|&nbsp;<font size="-2">TYPEDEFS</font>
|&nbsp;<a href="#publ_ops"><font size="-2"><b>METHODS</b></font></a>
|&nbsp;<font size="-2">STATIC METHODS</font>
|&nbsp;<font size="-2">DATA</font>
|&nbsp;<font size="-2">STATIC DATA</font></td>
</tr>
<tr>
<td width="20%"><font size="-2">PROTECTED MEMBERS:</font></td>
<td>
&nbsp;<font size="-2">CLASSES</font>
|&nbsp;<font size="-2">STRUCTS</font>
|&nbsp;<font size="-2">UNIONS</font>
|&nbsp;<font size="-2">ENUMS</font>
|&nbsp;<font size="-2">TYPEDEFS</font>
|&nbsp;<font size="-2">METHODS</font>
|&nbsp;<font size="-2">STATIC METHODS</font>
|&nbsp;<a href="#prot_vars"><font size="-2"><b>DATA</b></font></a>
|&nbsp;<font size="-2">STATIC DATA</font></td>
</tr>
</table>
<hr>
<a href="../names/index.html" alt="Global Namespace in C++"><font size="+1"><b>::</b></font></a> <div align="center" style="background-color:#ccccff; line-height:26pt;"><h2>class Registry</h2>
</div><hr>
<dl>
<dt>Base Classes</dt>
<dd>None.</dd>
</dl>
<dl>
<dt>Known Derived Classes</dt>
<dd>None.</dd>
</dl>
<br>
<table border cellspacing="0">
<tr>
<td bgcolor="#eeeeff" width="25%" style="font-family:Arial; font-size:8pt; font-weight:bold;">virtual</td>
<td bgcolor="#eeeeff" width="25%" style="font-family:Arial; font-size:8pt; font-weight:bold;">abstract</td>
<td bgcolor="#eeeeff" width="25%" style="font-family:Arial; font-size:8pt; font-weight:bold;">interface</td>
<td bgcolor="#eeeeff" width="25%" style="font-family:Arial; font-size:8pt; font-weight:bold;">template</td>
</tr>
<tr>
<td style="font-family:Arial; font-size:8pt;">NO</td>
<td style="font-family:Arial; font-size:8pt;">NO</td>
<td style="font-family:Arial; font-size:8pt;">NO</td>
<td style="font-family:Arial; font-size:8pt;">NO</td>
</tr>
</table>
<dl>
<dt>Summary</dt>
<dd>The Registry provides the functionality to read and write information in a registry file.
</dd>
<dt>Description</dt>
<dd>The class is implemented inline and use a load on call C-Api.
</dd>
</dl>
<dl>
<dt>File</dt>
<dd>registry.hxx</dd>
</dl>
<hr>
<dl>
<dt bgcolor="#CCCCFF"><a name="publ_"><h3>Public Members</h3>
</a>
</dt>
<dd><a name="publ_ops"> </a>
<table cellpadding="5" cellspacing="0" width="100%">
<tr bgcolor="#CCCCFF">
<td colspan="2"><h4>Methods</h4>
</td>
</tr>
<tr>
<td> <br>
<a href="Registry/o.html#Registry-546">Registry</a>( const Registry_Api * pApi );</td>
<td width="50%"> Constructor using the registry Api directly.
</td>
</tr>
<tr>
<td> <br>
<a href="Registry/o.html#Registry-547">Registry</a>( const RegistryLoader &amp; rLoader );</td>
<td width="50%"> Constructor using the loader mechanism.
</td>
</tr>
<tr>
<td> <br>
<a href="Registry/o.html#Registry-548">Registry</a>( const Registry &amp; toCopy );</td>
<td width="50%"> Copy constructor</td>
</tr>
<tr>
<td> <br>
<a href="Registry/o.html#~Registry-1">~Registry</a>( );</td>
<td width="50%"> Destructor. The Destructor close the registry if it is open.</td>
</tr>
<tr>
<td>Registry &amp; <br>
<a href="Registry/o.html#operator=-548">operator=</a>( const Registry &amp; toAssign );</td>
<td width="50%"> Assign operator</td>
</tr>
<tr>
<td>sal_Bool <br>
<a href="Registry/o.html#isValid-5">isValid</a>( ) const;</td>
<td width="50%"> checks if the registry points to a valid registry data file.</td>
</tr>
<tr>
<td>sal_Bool <br>
<a href="Registry/o.html#isReadOnly-5">isReadOnly</a>( ) const;</td>
<td width="50%"> returns the access mode of the registry.
</td>
</tr>
<tr>
<td>RegError <br>
<a href="Registry/o.html#openRootKey-549">openRootKey</a>( RegistryKey &amp; rRootKey );</td>
<td width="50%"> opens the root key of the registry.
</td>
</tr>
<tr>
<td>::rtl::OUString <br>
<a href="Registry/o.html#getName-1">getName</a>( );</td>
<td width="50%"> returns the name of the current registry data file.</td>
</tr>
<tr>
<td>RegError <br>
<a href="Registry/o.html#create-550">create</a>( const ::rtl::OUString &amp; registryName );</td>
<td width="50%"> creates a new registry with the specified name and creates a root key.
</td>
</tr>
<tr>
<td>RegError <br>
<a href="Registry/o.html#open-551">open</a>( const ::rtl::OUString &amp; registryName, RegAccessMode accessMode );</td>
<td width="50%"> opens a registry with the specified name.
</td>
</tr>
<tr>
<td>RegError <br>
<a href="Registry/o.html#close-1">close</a>( );</td>
<td width="50%"> closes explicitly the current registry data file.</td>
</tr>
<tr>
<td>RegError <br>
<a href="Registry/o.html#destroy-550">destroy</a>( const ::rtl::OUString &amp; registryName );</td>
<td width="50%"> destroys a registry.
</td>
</tr>
<tr>
<td>RegError <br>
<a href="Registry/o.html#loadKey-552">loadKey</a>( RegistryKey &amp; rKey, const ::rtl::OUString &amp; keyName, const ::rtl::OUString &amp; regFileName );</td>
<td width="50%"> loads registry information from a specified file and save it under the
specified keyName.
</td>
</tr>
<tr>
<td>RegError <br>
<a href="Registry/o.html#saveKey-552">saveKey</a>( RegistryKey &amp; rKey, const ::rtl::OUString &amp; keyName, const ::rtl::OUString &amp; regFileName );</td>
<td width="50%"> saves the registry information of the specified key and all subkeys and save
it in the specified file.
</td>
</tr>
<tr>
<td>RegError <br>
<a href="Registry/o.html#mergeKey-553">mergeKey</a>( RegistryKey &amp; rKey, const ::rtl::OUString &amp; keyName, const ::rtl::OUString &amp; regFileName, sal_Bool bWarnings = sal_False, sal_Bool bReport = sal_False );</td>
<td width="50%"> merges the registry information of the specified key with the registry
information of the specified file.
</td>
</tr>
<tr>
<td>RegError <br>
<a href="Registry/o.html#dumpRegistry-549">dumpRegistry</a>( RegistryKey &amp; rKey );</td>
<td width="50%"> This function reports the complete registry information of a key and all of its subkeys.
</td>
</tr>
<tr>
<td>const Registry_Api * <br>
<a href="Registry/o.html#getApi-1">getApi</a>( );</td>
<td width="50%"> returns the used registry Api.</td>
</tr>
</table>
<hr>
</dd>
</dl>
<dl>
<dt bgcolor="#CCCCFF"><a name="prot_"><h3>Protected Members</h3>
</a>
</dt>
<dd><a name="prot_vars"> </a>
<table cellpadding="5" cellspacing="0" width="100%">
<tr bgcolor="#CCCCFF">
<td colspan="2"><h4>Data</h4>
</td>
</tr>
<tr bgcolor="white">
<td>const <a href="c-Registry_Api.html">Registry_Api</a> * <a href="Registry/d.html#m_pApi"><strong>m_pApi;</strong></a></td>
<td>stores the used and initialized registry Api.</td>
</tr>
<tr bgcolor="white">
<td>::salhelper::ODynamicLoader&lt; Registry_Api &gt; <a href="Registry/d.html#m_Api"><strong>m_Api;</strong></a></td>
<td>stores the dynamic loader which is used to hold the library.</td>
</tr>
<tr bgcolor="white">
<td><a href="t-RegHandle.html">RegHandle</a> <a href="Registry/d.html#m_hImpl"><strong>m_hImpl;</strong></a></td>
<td>stores the handle of the underlying registry file on which most of the functions work.</td>
</tr>
</table>
<hr>
</dd>
</dl>
<a href="#_top_" class="objchapter">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright 2002 Sun Microsystems, Inc., 901 San Antonio Road, Palo Alto, CA 94303 USA.</p>
</body>