<html> <head> <title>Interface XRegistryKey</title> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <link rel="stylesheet" type="text/css" href="../../../../idl.css"> </head> <body> <div id="adc-idlref"> <a name="_top_"> </a><table class="navimain" border="0" cellpadding="3"> <tr> <td class="navimain"><a href="../module-ix.html" class="navimain">Overview</a></td> <td class="navimain"><a href="module-ix.html" class="navimain">Module</a></td> <td class="navimain"><a href="XRegistryKey-xref.html" class="navimain">Use</a></td> <td class="navimainnone">Devguide</td> <td class="navimain"><a href="../../../../index-files/index-1.html" class="navimain">Index</a></td> </tr> </table> <table class="navisub" border="0" cellpadding="0"> <tr> <td class="navisub"><a href="#MethodsSummary" class="navisub">Methods' Summary</a></td> <td class="navisub"><a href="#MethodsDetails" class="navisub">Methods' Details</a></td> <td class="navisub"><a href="#AttributesSummary" class="navisub">Attributes' Summary</a></td> <td class="navisub"><a href="#AttributesDetails" class="navisub">Attributes' Details</a></td> </tr> </table> <hr> <table border="0" width="100%" cellpadding="5" cellspacing="3" class="title-table" style="margin-bottom:6pt;"> <tr> <td><p class="namechain"><a href="../../../../module-ix.html" class="namechain">::</a> <a href="../../../module-ix.html" class="namechain">com</a> :: <a href="../../module-ix.html" class="namechain">sun</a> :: <a href="../module-ix.html" class="namechain">star</a> :: <a href="module-ix.html" class="namechain">registry</a> :: </p> </td> </tr> <tr> <td class="title">interface XRegistryKey</td> </tr> <tr> <td/></tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>makes structural information (except regarding tree structures) of a single registry key accessible. </dd> <dd><p>This is the main interface for registry keys.<p> </dd> <dt><b>See also</b></dt> <dd><a href="XSimpleRegistry.html">XSimpleRegistry</a></dd> </dl> </td> </tr> </table> <hr> <a name="MethodsSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Methods' Summary</td> </tr> <tr> <td class="imsum_left"><a href="#isReadOnly">isReadOnly</a></td> <td class="imsum_right">checks if the key can be overwritten. </td> </tr> <tr> <td class="imsum_left"><a href="#isValid">isValid</a></td> <td class="imsum_right">checks if the key points to an open valid key in the data-source. </td> </tr> <tr> <td class="imsum_left"><a href="#getKeyType">getKeyType</a></td> <td class="imsum_right"> </td> </tr> <tr> <td class="imsum_left"><a href="#getValueType">getValueType</a></td> <td class="imsum_right"> </td> </tr> <tr> <td class="imsum_left"><a href="#getLongValue">getLongValue</a></td> <td class="imsum_right"> </td> </tr> <tr> <td class="imsum_left"><a href="#setLongValue">setLongValue</a></td> <td class="imsum_right">sets a long value to the key. </td> </tr> <tr> <td class="imsum_left"><a href="#getLongListValue">getLongListValue</a></td> <td class="imsum_right"> </td> </tr> <tr> <td class="imsum_left"><a href="#setLongListValue">setLongListValue</a></td> <td class="imsum_right">sets a long list value to the key. </td> </tr> <tr> <td class="imsum_left"><a href="#getAsciiValue">getAsciiValue</a></td> <td class="imsum_right"> </td> </tr> <tr> <td class="imsum_left"><a href="#setAsciiValue">setAsciiValue</a></td> <td class="imsum_right">sets an ASCII string value to the key. </td> </tr> <tr> <td class="imsum_left"><a href="#getAsciiListValue">getAsciiListValue</a></td> <td class="imsum_right"> </td> </tr> <tr> <td class="imsum_left"><a href="#setAsciiListValue">setAsciiListValue</a></td> <td class="imsum_right">sets an ASCII string list value to the key. </td> </tr> <tr> <td class="imsum_left"><a href="#getStringValue">getStringValue</a></td> <td class="imsum_right"> </td> </tr> <tr> <td class="imsum_left"><a href="#setStringValue">setStringValue</a></td> <td class="imsum_right">sets a unicode string value to the key. </td> </tr> <tr> <td class="imsum_left"><a href="#getStringListValue">getStringListValue</a></td> <td class="imsum_right"> </td> </tr> <tr> <td class="imsum_left"><a href="#setStringListValue">setStringListValue</a></td> <td class="imsum_right">sets a unicode string value to the key. </td> </tr> <tr> <td class="imsum_left"><a href="#getBinaryValue">getBinaryValue</a></td> <td class="imsum_right"> </td> </tr> <tr> <td class="imsum_left"><a href="#setBinaryValue">setBinaryValue</a></td> <td class="imsum_right">sets a binary value to the key. </td> </tr> <tr> <td class="imsum_left"><a href="#openKey">openKey</a></td> <td class="imsum_right">opens a sub key of the key. </td> </tr> <tr> <td class="imsum_left"><a href="#createKey">createKey</a></td> <td class="imsum_right">creates a new key in the registry. </td> </tr> <tr> <td class="imsum_left"><a href="#closeKey">closeKey</a></td> <td class="imsum_right">closes a key in the registry. </td> </tr> <tr> <td class="imsum_left"><a href="#deleteKey">deleteKey</a></td> <td class="imsum_right">deletes a key from the registry. </td> </tr> <tr> <td class="imsum_left"><a href="#openKeys">openKeys</a></td> <td class="imsum_right">opens all subkeys of the key. If a subkey is a link, the link will be resolved and the appropriate key will be opened. </td> </tr> <tr> <td class="imsum_left"><a href="#getKeyNames">getKeyNames</a></td> <td class="imsum_right"> </td> </tr> <tr> <td class="imsum_left"><a href="#createLink">createLink</a></td> <td class="imsum_right">creates a new link in the registry. </td> </tr> <tr> <td class="imsum_left"><a href="#deleteLink">deleteLink</a></td> <td class="imsum_right">deletes a link from the registry. </td> </tr> <tr> <td class="imsum_left"><a href="#getLinkTarget">getLinkTarget</a></td> <td class="imsum_right"> </td> </tr> <tr> <td class="imsum_left"><a href="#getResolvedName">getResolvedName</a></td> <td class="imsum_right"> </td> </tr> </table> <a name="MethodsDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle">Methods' Details</td> </tr> <tr> <td class="imdetail"><a name="isReadOnly" class="membertitle">isReadOnly</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">boolean</td> </tr> <tr> <td valign="top"><b>isReadOnly</b>()</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="InvalidRegistryException.html">InvalidRegistryException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>checks if the key can be overwritten. </dd> <dt><b>Throws</b></dt> <dd>InvalidRegistryException if the registry is not open. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="isValid" class="membertitle">isValid</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">boolean</td> </tr> <tr> <td valign="top"><b>isValid</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>checks if the key points to an open valid key in the data-source. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getKeyType" class="membertitle">getKeyType</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3"><a href="RegistryKeyType.html">RegistryKeyType</a></td> </tr> <tr> <td valign="top"><b>getKeyType</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> rKeyName )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="InvalidRegistryException.html">InvalidRegistryException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Returns</b></dt> <dd>the type of the specified key. </dd> <dt><b>Parameter rKeyName</b></dt> <dd>specifies the relative path from the current key to the key of the type which will be returned. </dd> <dt><b>Throws</b></dt> <dd>InvalidRegistryException if the registry is not open. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getValueType" class="membertitle">getValueType</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3"><a href="RegistryValueType.html">RegistryValueType</a></td> </tr> <tr> <td valign="top"><b>getValueType</b>()</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="InvalidRegistryException.html">InvalidRegistryException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Returns</b></dt> <dd>the type of the key value or NOT_DEFINED if the key has no value. </dd> <dt><b>Throws</b></dt> <dd>InvalidRegistryException if the registry is not open. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getLongValue" class="membertitle">getLongValue</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">long</td> </tr> <tr> <td valign="top"><b>getLongValue</b>()</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="InvalidRegistryException.html">InvalidRegistryException</a>,<br> <a href="InvalidValueException.html">InvalidValueException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Returns</b></dt> <dd>a long value if the key contains one. </dd> <dt><b>Throws</b></dt> <dd>InvalidRegistryException if the registry is not open. </dd> <dt><b>Throws</b></dt> <dd>InvalidValueException if the value is not of type long. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="setLongValue" class="membertitle">setLongValue</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>setLongValue</b>(</td> <td valign="top">[in] long</td> <td valign="bottom"> value )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="InvalidRegistryException.html">InvalidRegistryException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>sets a long value to the key. </dd> <dd><p>If the key already has a value, the value will be overridden. </dd> <dt><b>Throws</b></dt> <dd>InvalidRegistryException if the registry is not open. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getLongListValue" class="membertitle">getLongListValue</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">sequence< long ></td> </tr> <tr> <td valign="top"><b>getLongListValue</b>()</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="InvalidRegistryException.html">InvalidRegistryException</a>,<br> <a href="InvalidValueException.html">InvalidValueException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Returns</b></dt> <dd>a sequence of longs if the key contains a long list value. </dd> <dt><b>Throws</b></dt> <dd>InvalidRegistryException if the registry is not open. </dd> <dt><b>Throws</b></dt> <dd>InvalidValueException if the actual value is not of type long list. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="setLongListValue" class="membertitle">setLongListValue</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>setLongListValue</b>(</td> <td valign="top">[in] sequence< long ></td> <td valign="bottom"> seqValue )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="InvalidRegistryException.html">InvalidRegistryException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>sets a long list value to the key. </dd> <dd><p>If the key already has a value, the value will be overridden. </dd> <dt><b>Throws</b></dt> <dd>InvalidRegistryException if the registry is not open. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getAsciiValue" class="membertitle">getAsciiValue</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">string</td> </tr> <tr> <td valign="top"><b>getAsciiValue</b>()</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="InvalidRegistryException.html">InvalidRegistryException</a>,<br> <a href="InvalidValueException.html">InvalidValueException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Returns</b></dt> <dd>an ascii string value if the key contains one. </dd> <dt><b>Throws</b></dt> <dd>InvalidRegistryException if the registry is not open. </dd> <dt><b>Throws</b></dt> <dd>InvalidValueException if the actual value is not of type ascii. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="setAsciiValue" class="membertitle">setAsciiValue</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>setAsciiValue</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> value )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="InvalidRegistryException.html">InvalidRegistryException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>sets an ASCII string value to the key. </dd> <dd><p>The high byte of the string should be NULL. If not, there is no guarantee that the string will be correctly transported. If the key already has a value, the value will be overridden. </dd> <dt><b>Throws</b></dt> <dd>InvalidRegistryException if the registry is not open. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getAsciiListValue" class="membertitle">getAsciiListValue</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">sequence< string ></td> </tr> <tr> <td valign="top"><b>getAsciiListValue</b>()</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="InvalidRegistryException.html">InvalidRegistryException</a>,<br> <a href="InvalidValueException.html">InvalidValueException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Returns</b></dt> <dd>a sequence of ascii strings if the key contains an asci list value. </dd> <dt><b>Throws</b></dt> <dd>InvalidRegistryException if the registry is not open. </dd> <dt><b>Throws</b></dt> <dd>InvalidValueException if the actual value is not of type ascii list. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="setAsciiListValue" class="membertitle">setAsciiListValue</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>setAsciiListValue</b>(</td> <td valign="top">[in] sequence< string ></td> <td valign="bottom"> seqValue )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="InvalidRegistryException.html">InvalidRegistryException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>sets an ASCII string list value to the key. </dd> <dd><p>The high byte of the string should be NULL. If not, there is no guarantee that the string will be correctly transported. If the key already has a value, the value will be overridden. </dd> <dt><b>Throws</b></dt> <dd>InvalidRegistryException if the registry is not open. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getStringValue" class="membertitle">getStringValue</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">string</td> </tr> <tr> <td valign="top"><b>getStringValue</b>()</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="InvalidRegistryException.html">InvalidRegistryException</a>,<br> <a href="InvalidValueException.html">InvalidValueException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Returns</b></dt> <dd>a unicode string value if the key contains one. </dd> <dt><b>Throws</b></dt> <dd>InvalidRegistryException if the registry is not open. </dd> <dt><b>Throws</b></dt> <dd>InvalidValueException if the actual value is not of type string. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="setStringValue" class="membertitle">setStringValue</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>setStringValue</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> value )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="InvalidRegistryException.html">InvalidRegistryException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>sets a unicode string value to the key. </dd> <dd><p> If the key already has a value, the value will be overridden. </dd> <dt><b>Throws</b></dt> <dd>InvalidRegistryException if the registry is not open. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getStringListValue" class="membertitle">getStringListValue</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">sequence< string ></td> </tr> <tr> <td valign="top"><b>getStringListValue</b>()</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="InvalidRegistryException.html">InvalidRegistryException</a>,<br> <a href="InvalidValueException.html">InvalidValueException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Returns</b></dt> <dd>a sequence of unicode strings if the key contains an unicode string list value. </dd> <dt><b>Throws</b></dt> <dd>InvalidRegistryException if the registry is not open. </dd> <dt><b>Throws</b></dt> <dd>InvalidValueException if the actual value is not of type string list. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="setStringListValue" class="membertitle">setStringListValue</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>setStringListValue</b>(</td> <td valign="top">[in] sequence< string ></td> <td valign="bottom"> seqValue )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="InvalidRegistryException.html">InvalidRegistryException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>sets a unicode string value to the key. </dd> <dd><p>If the key already has a value, the value will be overridden. </dd> <dt><b>Throws</b></dt> <dd>InvalidRegistryException if the registry is not open. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getBinaryValue" class="membertitle">getBinaryValue</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">sequence< byte ></td> </tr> <tr> <td valign="top"><b>getBinaryValue</b>()</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="InvalidRegistryException.html">InvalidRegistryException</a>,<br> <a href="InvalidValueException.html">InvalidValueException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Returns</b></dt> <dd>a binary value if the key contains one. </dd> <dt><b>Throws</b></dt> <dd>InvalidRegistryException if the registry is not open. </dd> <dt><b>Throws</b></dt> <dd>InvalidValueException if the actual value is not of type binary. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="setBinaryValue" class="membertitle">setBinaryValue</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>setBinaryValue</b>(</td> <td valign="top">[in] sequence< byte ></td> <td valign="bottom"> value )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="InvalidRegistryException.html">InvalidRegistryException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>sets a binary value to the key. </dd> <dd><p>If the key already has a value, the value will be overridden. </dd> <dt><b>Throws</b></dt> <dd>InvalidRegistryException if the registry is not open. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="openKey" class="membertitle">openKey</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3"><a href="XRegistryKey.html">XRegistryKey</a></td> </tr> <tr> <td valign="top"><b>openKey</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> aKeyName )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="InvalidRegistryException.html">InvalidRegistryException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>opens a sub key of the key. </dd> <dd><p>If the sub key does not exist, the function returns a NULL-interface. </dd> <dt><b>Parameter aKeyName</b></dt> <dd>the relative path from the current key to the key which will be created. </dd> <dt><b>Returns</b></dt> <dd>a NULL interface if the key does not exist. </dd> <dt><b>Throws</b></dt> <dd>InvalidRegistryException if the registry is not open. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="createKey" class="membertitle">createKey</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3"><a href="XRegistryKey.html">XRegistryKey</a></td> </tr> <tr> <td valign="top"><b>createKey</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> aKeyName )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="InvalidRegistryException.html">InvalidRegistryException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>creates a new key in the registry.</dd> <dd><p> <p>If the key already exists, the function will open the key. </dd> <dt><b>Parameter aKeyName</b></dt> <dd>specifies the relative path from the current key to the key which will be created. </dd> <dt><b>Returns</b></dt> <dd>a NULL interface if the key could not be created. </dd> <dt><b>Throws</b></dt> <dd>InvalidRegistryException if the registry is not open, the registry is readonly or if the key exists and is of type LINK. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="closeKey" class="membertitle">closeKey</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>closeKey</b>()</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="InvalidRegistryException.html">InvalidRegistryException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>closes a key in the registry. </dd> <dt><b>Throws</b></dt> <dd>InvalidRegistryException if the registry is not open. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="deleteKey" class="membertitle">deleteKey</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>deleteKey</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> rKeyName )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="InvalidRegistryException.html">InvalidRegistryException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>deletes a key from the registry. </dd> <dt><b>Parameter aKeyName</b></dt> <dd>specifies the relative path from the current key to the key which will be deleted. </dd> <dt><b>Throws</b></dt> <dd>InvalidRegistryException if the registry is not open, the registry is readonly, the key does not exists or if the key is of type LINK. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="openKeys" class="membertitle">openKeys</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">sequence< <a href="XRegistryKey.html">XRegistryKey</a> ></td> </tr> <tr> <td valign="top"><b>openKeys</b>()</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="InvalidRegistryException.html">InvalidRegistryException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>opens all subkeys of the key. If a subkey is a link, the link will be resolved and the appropriate key will be opened. </dd> <dt><b>Returns</b></dt> <dd>an empty sequence if the key has no subkeys. </dd> <dt><b>Throws</b></dt> <dd>InvalidRegistryException if the registry is not open. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getKeyNames" class="membertitle">getKeyNames</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">sequence< string ></td> </tr> <tr> <td valign="top"><b>getKeyNames</b>()</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="InvalidRegistryException.html">InvalidRegistryException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Returns</b></dt> <dd>a sequence with the names of all subkeys of the key. If the key has no subkeys, the function returns an empty sequence. If a subkey is a link, the name of the link will be returned. </dd> <dt><b>Throws</b></dt> <dd>InvalidRegistryException if the registry is not open. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="createLink" class="membertitle">createLink</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">boolean</td> </tr> <tr> <td valign="top"><b>createLink</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> aLinkName,</td> </tr> <tr> <td/><td valign="top">[in] string</td> <td valign="bottom"> aLinkTarget )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="InvalidRegistryException.html">InvalidRegistryException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>creates a new link in the registry. </dd> <dt><b>Returns</b></dt> <dd><b>true</b> if the link was created. If the link already exists or the link target does not exist, the function returns <b>false</b>. </dd> <dt><b>Parameter aLinkName</b></dt> <dd>specifies the relative path from the current key to the link which will be created. </dd> <dt><b>Parameter aLinkTarget</b></dt> <dd>specifies the full path of the key which will be referenced by the link. </dd> <dt><b>Throws</b></dt> <dd>InvalidRegistryException if the registry is not open or the registry is readonly. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="deleteLink" class="membertitle">deleteLink</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>deleteLink</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> rLinkName )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="InvalidRegistryException.html">InvalidRegistryException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>deletes a link from the registry. </dd> <dt><b>Parameter aLinkName</b></dt> <dd>specifies the relative path from the current key to the link which will be deleted. </dd> <dt><b>Throws</b></dt> <dd>InvalidRegistryException if the registry is not open, the registry is readonly, or if the link does not exist. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getLinkTarget" class="membertitle">getLinkTarget</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">string</td> </tr> <tr> <td valign="top"><b>getLinkTarget</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> rLinkName )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="InvalidRegistryException.html">InvalidRegistryException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Returns</b></dt> <dd>the target (complete path of a key) of the link specified by rLinkName. </dd> <dt><b>Parameter rLinKName</b></dt> <dd>specifies the relative path from the current key to the link which target will be returned. </dd> <dt><b>Throws</b></dt> <dd>InvalidRegistryException if the registry is not open or the link does not exists. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getResolvedName" class="membertitle">getResolvedName</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">string</td> </tr> <tr> <td valign="top"><b>getResolvedName</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> aKeyName )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="InvalidRegistryException.html">InvalidRegistryException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Returns</b></dt> <dd>the resolved name of a key. The function resolve the complete name of the key. If a link could not be resolved, the linktarget concatenated with the unresolved rest of the name, will be returned. </dd> <dt><b>Parameter rKeyName</b></dt> <dd>specifies a relative path from the current key which will be resolved from all links. </dd> <dt><b>Throws</b></dt> <dd>InvalidRegistryException if the registry is not open or a recursion was detected. </dd> </dl> </td> </tr> </table> </td> </tr> </table> <a name="AttributesSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Attributes' Summary</td> </tr> <tr> <td class="imsum_left"><a href="#KeyName">KeyName</a></td> <td class="imsum_right">This is the key of the entry relative to its parent. </td> </tr> </table> <a name="AttributesDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle">Attributes' Details</td> </tr> <tr> <td class="imdetail"><a name="KeyName" class="membertitle">KeyName</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ readonly ] string <b>KeyName</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>This is the key of the entry relative to its parent.</dd> <dd><p> <p>The access path starts with the root "/" and all parent entry names are delimited with slashes "/" too, like in a UNIX (R) file system. Slashes which are part of single names are represented as hexadecimals preceded with a "%" like in URL syntax. </dd> </dl> </td> </tr> </table> </td> </tr> </table> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2008 Sun Microsystems, Inc.</p> </div> <!-- id="adc-idlref" --> </body> </html>
distrib
>
Mandriva
>
2008.1
>
x86_64
>
media
>
main-testing
>
by-pkgid
>
2c50825dd66d0497b96a67f7fab2ee84
>
files
>
4554
