| <html> |
| <head> |
| <title>class RegistryKey</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"> <a href="../index.html" alt><font family="Arial" color="#000000" size="+1"><b>Overview</b></font></a> </td> |
| <td bgcolor="#eeeeff"> <a href="index.html" alt><font family="Arial" color="#000000" size="+1"><b>Namespace</b></font></a> </td> |
| <td bgcolor="#2222ad"> <font family="Arial" color="#ffffff" size="+1"><b>Class</b></font> </td> |
| <td bgcolor="#eeeeff"> <a href="../index-files/index-1.html" alt><font family="Arial" color="#000000" size="+1"><b>Index</b></font></a> </td> |
| <td bgcolor="#eeeeff"> <a href="../help.html" alt><font family="Arial" color="#000000" size="+1"><b>Help</b></font></a> </td> |
| </tr> |
| </table> |
| <table cellpadding="0" cellspacing="3"> |
| <tr> |
| <td width="20%"><font size="-2">PUBLIC MEMBERS:</font></td> |
| <td> |
| <font size="-2">CLASSES</font> |
| | <font size="-2">STRUCTS</font> |
| | <font size="-2">UNIONS</font> |
| | <font size="-2">ENUMS</font> |
| | <font size="-2">TYPEDEFS</font> |
| | <a href="#publ_ops"><font size="-2"><b>METHODS</b></font></a> |
| | <font size="-2">STATIC METHODS</font> |
| | <font size="-2">DATA</font> |
| | <font size="-2">STATIC DATA</font></td> |
| </tr> |
| <tr> |
| <td width="20%"><font size="-2">PROTECTED MEMBERS:</font></td> |
| <td> |
| <font size="-2">CLASSES</font> |
| | <font size="-2">STRUCTS</font> |
| | <font size="-2">UNIONS</font> |
| | <font size="-2">ENUMS</font> |
| | <font size="-2">TYPEDEFS</font> |
| | <font size="-2">METHODS</font> |
| | <font size="-2">STATIC METHODS</font> |
| | <a href="#prot_vars"><font size="-2"><b>DATA</b></font></a> |
| | <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 RegistryKey</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>RegistryKey reads or writes information of the underlying key in a registry. |
| |
| </dd> |
| <dt>Description</dt> |
| <dd>Class is 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="RegistryKey/o.html#RegistryKey-1">RegistryKey</a>( );</td> |
| <td width="50%"> Default constructor</td> |
| </tr> |
| <tr> |
| <td> <br> |
| <a href="RegistryKey/o.html#RegistryKey-560">RegistryKey</a>( const RegistryKey & toCopy );</td> |
| <td width="50%"> Copy constructor</td> |
| </tr> |
| <tr> |
| <td> <br> |
| <a href="RegistryKey/o.html#~RegistryKey-1">~RegistryKey</a>( );</td> |
| <td width="50%"> Destructor, close the key if it references an open one.</td> |
| </tr> |
| <tr> |
| <td>RegistryKey & <br> |
| <a href="RegistryKey/o.html#operator=-560">operator=</a>( const RegistryKey & toAssign );</td> |
| <td width="50%"> Assign operator</td> |
| </tr> |
| <tr> |
| <td>sal_Bool <br> |
| <a href="RegistryKey/o.html#isValid-5">isValid</a>( ) const;</td> |
| <td width="50%"> checks if the key points to a valid registry key.</td> |
| </tr> |
| <tr> |
| <td>sal_Bool <br> |
| <a href="RegistryKey/o.html#isReadOnly-5">isReadOnly</a>( ) const;</td> |
| <td width="50%"> returns the access mode of the key. |
| |
| </td> |
| </tr> |
| <tr> |
| <td>::rtl::OUString <br> |
| <a href="RegistryKey/o.html#getName-1">getName</a>( );</td> |
| <td width="50%"> returns the full qualified name of the key beginning with the rootkey.</td> |
| </tr> |
| <tr> |
| <td>RegError <br> |
| <a href="RegistryKey/o.html#createKey-561">createKey</a>( const ::rtl::OUString & keyName, RegistryKey & rNewKey );</td> |
| <td width="50%"> creates a new key or opens a key if the specified key already exists. |
| |
| </td> |
| </tr> |
| <tr> |
| <td>RegError <br> |
| <a href="RegistryKey/o.html#openKey-561">openKey</a>( const ::rtl::OUString & keyName, RegistryKey & rOpenKey );</td> |
| <td width="50%"> opens the specified key. |
| |
| </td> |
| </tr> |
| <tr> |
| <td>RegError <br> |
| <a href="RegistryKey/o.html#openSubKeys-562">openSubKeys</a>( const ::rtl::OUString & keyName, RegistryKeyArray & rSubKeys );</td> |
| <td width="50%"> opens all subkeys of the specified key. |
| |
| </td> |
| </tr> |
| <tr> |
| <td>RegError <br> |
| <a href="RegistryKey/o.html#getKeyNames-563">getKeyNames</a>( const ::rtl::OUString & keyName, RegistryKeyNames & rSubKeyNames );</td> |
| <td width="50%"> returns an array with the names of all subkeys of the specified key. |
| |
| </td> |
| </tr> |
| <tr> |
| <td>RegError <br> |
| <a href="RegistryKey/o.html#closeSubKeys-564">closeSubKeys</a>( RegistryKeyArray & rSubKeys );</td> |
| <td width="50%"> closes all keys specified in the array. |
| |
| </td> |
| </tr> |
| <tr> |
| <td>RegError <br> |
| <a href="RegistryKey/o.html#deleteKey-565">deleteKey</a>( const ::rtl::OUString & keyName );</td> |
| <td width="50%"> deletes the specified key. |
| |
| </td> |
| </tr> |
| <tr> |
| <td>RegError <br> |
| <a href="RegistryKey/o.html#closeKey-1">closeKey</a>( );</td> |
| <td width="50%"> closes explicitly the current key</td> |
| </tr> |
| <tr> |
| <td>RegError <br> |
| <a href="RegistryKey/o.html#setValue-566">setValue</a>( const ::rtl::OUString & keyName, RegValueType valueType, RegValue pValue, sal_uInt32 valueSize );</td> |
| <td width="50%"> sets a value of a key. |
| |
| </td> |
| </tr> |
| <tr> |
| <td>RegError <br> |
| <a href="RegistryKey/o.html#setLongListValue-567">setLongListValue</a>( const ::rtl::OUString & keyName, sal_Int32 * pValueList, sal_uInt32 len );</td> |
| <td width="50%"> sets a long list value of a key. |
| |
| </td> |
| </tr> |
| <tr> |
| <td>RegError <br> |
| <a href="RegistryKey/o.html#setStringListValue-568">setStringListValue</a>( const ::rtl::OUString & keyName, sal_Char * * pValueList, sal_uInt32 len );</td> |
| <td width="50%"> sets an ascii list value of a key. |
| |
| </td> |
| </tr> |
| <tr> |
| <td>RegError <br> |
| <a href="RegistryKey/o.html#setUnicodeListValue-569">setUnicodeListValue</a>( const ::rtl::OUString & keyName, sal_Unicode * * pValueList, sal_uInt32 len );</td> |
| <td width="50%"> sets an unicode string list value of a key. |
| |
| </td> |
| </tr> |
| <tr> |
| <td>RegError <br> |
| <a href="RegistryKey/o.html#getValueInfo-570">getValueInfo</a>( const ::rtl::OUString & keyName, RegValueType * pValueType, sal_uInt32 * pValueSize );</td> |
| <td width="50%"> gets info about type and size of a value. |
| |
| </td> |
| </tr> |
| <tr> |
| <td>RegError <br> |
| <a href="RegistryKey/o.html#getValue-571">getValue</a>( const ::rtl::OUString & keyName, RegValue pValue );</td> |
| <td width="50%"> gets the value of a key. |
| |
| </td> |
| </tr> |
| <tr> |
| <td>RegError <br> |
| <a href="RegistryKey/o.html#getLongListValue-572">getLongListValue</a>( const ::rtl::OUString & keyName, RegistryValueList< sal_Int32 > & rValueList );</td> |
| <td width="50%"> gets a long list value of a key. |
| |
| </td> |
| </tr> |
| <tr> |
| <td>RegError <br> |
| <a href="RegistryKey/o.html#getStringListValue-573">getStringListValue</a>( const ::rtl::OUString & keyName, RegistryValueList< sal_Char * > & rValueList );</td> |
| <td width="50%"> gets an ascii list value of a key. |
| |
| </td> |
| </tr> |
| <tr> |
| <td>RegError <br> |
| <a href="RegistryKey/o.html#getUnicodeListValue-574">getUnicodeListValue</a>( const ::rtl::OUString & keyName, RegistryValueList< sal_Unicode * > & rValueList );</td> |
| <td width="50%"> gets a unicode value of a key. |
| |
| </td> |
| </tr> |
| <tr> |
| <td>RegError <br> |
| <a href="RegistryKey/o.html#createLink-575">createLink</a>( const ::rtl::OUString & linkName, const ::rtl::OUString & linkTarget );</td> |
| <td width="50%"> creates a new link with the specified name and target. |
| |
| </td> |
| </tr> |
| <tr> |
| <td>RegError <br> |
| <a href="RegistryKey/o.html#deleteLink-565">deleteLink</a>( const ::rtl::OUString & linkName );</td> |
| <td width="50%"> deletes an existing link. |
| |
| </td> |
| </tr> |
| <tr> |
| <td>RegError <br> |
| <a href="RegistryKey/o.html#getKeyType-576">getKeyType</a>( const ::rtl::OUString & name, RegKeyType * pKeyType ) const;</td> |
| <td width="50%"> returns the type of the specified key if it is a link or a real key. |
| |
| </td> |
| </tr> |
| <tr> |
| <td>RegError <br> |
| <a href="RegistryKey/o.html#getLinkTarget-577">getLinkTarget</a>( const ::rtl::OUString & linkName, ::rtl::OUString & rLinkTarget ) const;</td> |
| <td width="50%"> returns the target of the specified link. |
| |
| </td> |
| </tr> |
| <tr> |
| <td>RegError <br> |
| <a href="RegistryKey/o.html#getResolvedKeyName-578">getResolvedKeyName</a>( const ::rtl::OUString & keyName, sal_Bool firstLinkOnly, ::rtl::OUString & rResolvedName ) const;</td> |
| <td width="50%"> resolves all or only the first link of a keyname. |
| |
| </td> |
| </tr> |
| <tr> |
| <td>::rtl::OUString <br> |
| <a href="RegistryKey/o.html#getRegistryName-1">getRegistryName</a>( );</td> |
| <td width="50%"> returns the name of the registry in which the key is defined.</td> |
| </tr> |
| <tr> |
| <td>Registry <br> |
| <a href="RegistryKey/o.html#getRegistry-5">getRegistry</a>( ) const;</td> |
| <td width="50%"> returns the registry in which the key is defined.</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><a href="c-Registry.html">Registry</a> <a href="RegistryKey/d.html#m_registry"><strong>m_registry;</strong></a></td> |
| <td>stores the registry on which this key works</td> |
| </tr> |
| <tr bgcolor="white"> |
| <td><a href="t-RegKeyHandle.html">RegKeyHandle</a> <a href="RegistryKey/d.html#m_hImpl"><strong>m_hImpl;</strong></a></td> |
| <td>stores the current key handle of this key</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> |
