Methods of Class RegistryKey
- RegistryKey
- RegistryKey();
-
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
NO |
- Summary
- Default constructor
- RegistryKey
- RegistryKey(
-
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
NO |
- Summary
- Copy constructor
- ~RegistryKey
- ~RegistryKey();
-
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
NO |
- Summary
- Destructor, close the key if it references an open one.
- operator=
- RegistryKey & operator=(
-
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
NO |
- Summary
- Assign operator
- isValid
- sal_Bool isValid();
-
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
NO |
- Summary
- checks if the key points to a valid registry key.
- isReadOnly
- sal_Bool isReadOnly();
-
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
NO |
- Summary
- returns the access mode of the key.
- Return
- TRUE if access mode is read only else FALSE.
- getName
- ::rtl::OUString getName();
-
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
NO |
- Summary
- returns the full qualified name of the key beginning with the rootkey.
- createKey
- RegError createKey(
-
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
NO |
- Summary
- creates a new key or opens a key if the specified key already exists.
- Description
- The specified keyname is relativ to this key.
- Parameters
keyName |
specifies the name of the key which will be opened or created.
|
rNewKey |
references a RegistryKey which will be filled with the new or open key.
|
- Return
- REG_NO_ERROR if succeeds else an error code.
- openKey
- RegError openKey(
-
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
NO |
- Summary
- opens the specified key.
- Description
- The specified keyname is relativ to this key.
- Parameters
keyName |
specifies the name of the key which will be opened.
|
rOpenKey |
references a RegistryKey which will be filled with the open key.
|
- Return
- REG_NO_ERROR if succeeds else an error code.
- openSubKeys
- RegError openSubKeys(
-
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
NO |
- Summary
- opens all subkeys of the specified key.
- Description
- The specified keyname is relativ to this key.
- Parameters
keyName |
specifies the name of the key which subkeys will be opened.
|
rSubKeys |
reference a RegistryKeyArray which will be filled with the open subkeys.
|
- Return
- REG_NO_ERROR if succeeds else an error code.
- getKeyNames
- RegError getKeyNames(
-
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
NO |
- Summary
- returns an array with the names of all subkeys of the specified key.
- Description
- The specified keyname is relativ to this key.
- Parameters
keyName |
specifies the name of the key which subkey names will be returned.
|
rSubKeyNames |
reference a RegistryKeyNames array which will be filled with the subkey names.
|
- Return
- REG_NO_ERROR if succeeds else an error code.
- closeSubKeys
- RegError closeSubKeys(
-
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
NO |
- Summary
- closes all keys specified in the array.
- Parameters
rSubKeys |
reference a RegistryKeyArray which contains the open keys.
|
- Return
- REG_NO_ERROR if succeeds else an error code.
- deleteKey
- RegError deleteKey(
-
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
NO |
- Summary
- deletes the specified key.
- Parameters
keyName |
specifies the name of the key which will be deleted.
|
- Return
- REG_NO_ERROR if succeeds else an error code.
- closeKey
- RegError closeKey();
-
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
NO |
- Summary
- closes explicitly the current key
- releaseKey
- void releaseKey();
-
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
NO |
- Summary
- releases the current key
- setValue
- RegError setValue(
-
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
NO |
- Summary
- sets a value of a key.
- Parameters
keyName |
specifies the name of the key which value will be set.
If keyName is an empty string, the value will be set for the key
specified by hKey.
|
valueType |
specifies the type of the value.
|
pData |
points to a memory block containing the data for the value.
|
valueSize |
specifies the size of pData in bytes
|
- Return
- REG_NO_ERROR if succeeds else an error code.
- setLongListValue
- RegError setLongListValue(
-
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
NO |
- Summary
- sets a long list value of a key.
- Parameters
keyName |
specifies the name of the key which value will be set.
If keyName is an empty string, the value will be set for the key
specified by hKey.
|
pValueList |
points to an array of longs containing the data for the value.
|
len |
specifies the length of the list (the array referenced by pValueList).
|
- Return
- REG_NO_ERROR if succeeds else an error code.
- setStringListValue
- RegError setStringListValue(
-
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
NO |
- Summary
- sets an ascii list value of a key.
- Parameters
keyName |
specifies the name of the key which value will be set.
If keyName is an empty string, the value will be set for the key
specified by hKey.
|
pValueList |
points to an array of sal_Char* containing the data for the value.
|
len |
specifies the length of the list (the array referenced by pValueList).
|
- Return
- REG_NO_ERROR if succeeds else an error code.
- setUnicodeListValue
- RegError setUnicodeListValue(
-
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
NO |
- Summary
- sets an unicode string list value of a key.
- Parameters
keyName |
specifies the name of the key which value will be set.
If keyName is an empty string, the value will be set for the key
specified by hKey.
|
pValueList |
points to an array of sal_Unicode* containing the data for the value.
|
len |
specifies the length of the list (the array referenced by pValueList).
|
- Return
- REG_NO_ERROR if succeeds else an error code.
- getValueInfo
- RegError getValueInfo(
-
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
NO |
- Summary
- gets info about type and size of a value.
- Parameters
keyName |
specifies the name of the key which value info will be returned.
If keyName is an empty string, the value info of the key
specified by hKey will be returned.
|
pValueType |
returns the type of the value.
|
pValueSize |
returns the size of the value in bytes or the length of a list value.
|
- Return
- REG_NO_ERROR if succeeds else an error code.
- getValue
- RegError getValue(
-
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
NO |
- Summary
- gets the value of a key.
- Parameters
keyName |
specifies the name of the key which value will be returned.
If keyName is an empty string, the value is get from the key
specified by hKey.
|
pValue |
points to an allocated memory block receiving the data of the value.
|
- Return
- REG_NO_ERROR if succeeds else an error code.
- getLongListValue
- RegError getLongListValue(
-
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
NO |
- Summary
- gets a long list value of a key.
- Parameters
keyName |
specifies the name of the key which value will be returned.
If keyName is an empty string, the value is get from the key
specified by hKey.
|
rValueList |
references a RegistryValueList which will be filled with the long values.
|
- Return
- REG_NO_ERROR if succeeds else an error code.
- getStringListValue
- RegError getStringListValue(
-
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
NO |
- Summary
- gets an ascii list value of a key.
- Parameters
keyName |
specifies the name of the key which value will be returned.
If keyName is an empty string, the value is get from the key
specified by hKey.
|
rValueList |
references a RegistryValueList which will be filled with the ascii values.
|
- Return
- REG_NO_ERROR if succeeds else an error code.
- getUnicodeListValue
- RegError getUnicodeListValue(
-
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
NO |
- Summary
- gets a unicode value of a key.
- Parameters
keyName |
specifies the name of the key which value will be returned.
If keyName is an empty string, the value is get from the key
specified by hKey.
|
rValueList |
reference a RegistryValueList which will be filled with the unicode values.
|
- Return
- REG_NO_ERROR if succeeds else an error code.
- createLink
- RegError createLink(
-
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
NO |
- D E P R E C A T E D
- Summary
- used to create a link.
- Description
- Links are no longer supported.
- Return
- REG_INVALID_LINK
- deleteLink
- RegError deleteLink(
-
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
NO |
- D E P R E C A T E D
- Summary
- used to delete a link.
- Description
- Links are no longer supported.
- Return
- REG_INVALID_LINK
- getKeyType
- RegError getKeyType(
-
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
YES |
NO |
NO |
NO |
YES |
NO |
- Summary
- returns the type of the specified key.
- Parameters
name |
specifies the name of the key or link.
|
pKeyType |
returns the type of the key (always RG_KEYTYPE).
|
- Return
- REG_NO_ERROR if succeeds else an error code.
- getLinkTarget
- RegError getLinkTarget(
-
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
YES |
NO |
NO |
NO |
YES |
NO |
- D E P R E C A T E D
- Summary
- used to return the target of a link.
- Description
- Links are no longer supported.
- Return
- REG_INVALID_LINK
- getResolvedKeyName
- RegError getResolvedKeyName(
-
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
YES |
NO |
NO |
NO |
YES |
NO |
- Summary
- resolves a keyname.
- Parameters
keyName |
specifies the name of the key which will be resolved relativ to this key.
The resolved name will be prefixed with the name of this key.
|
firstLinkOnly |
ignored
|
- Return
- REG_NO_ERROR if succeeds else an error code.
- getRegistryName
- ::rtl::OUString getRegistryName();
-
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
NO |
- Summary
- returns the name of the registry in which the key is defined.
- getRegistry
- Registry getRegistry();
-
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
NO |
- Summary
- returns the registry in which the key is defined.
Top of Page
Copyright © 2000, 2015 LibreOffice contributors and/or their affiliates. All rights reserved.
LibreOffice was created by The Document Foundation, based on OpenOffice.org, which is Copyright 2000, 2010 Oracle and/or its affiliates.
The Document Foundation acknowledges all community members, please find more info at our website.
Privacy Policy | Impressum (Legal Info) | Copyright information: The source code of LibreOffice is licensed under the GNU Lesser General Public License (LGPLv3). "LibreOffice" and "The Document Foundation" are registered trademarks of their corresponding registered owners or are in actual use as trademarks in one or more countries. Their respective logos and icons are also subject to international copyright laws. Use thereof is explained in our trademark policy.