/**
@class wxRegKey
- @wxheader{msw/registry.h}
wxRegKey is a class representing the Windows registry (it is only available
under Windows). One can create, query and delete registry keys using this
The constructor to set the full name of the key.
*/
wxRegKey(const wxString& strKey);
+ /**
+ The constructor to set the full name of the key using one of the
+ standard keys, that is, HKCR, HKCU, HKLM, HKUSR, HKPD, HKCC or HKDD.
+ */
+ wxRegKey(StdKey keyParent, const wxString& strKey);
/**
The constructor to set the full name of the key under a previously created
parent.
*/
enum AccessMode
{
- Read, ///< Read-only
- Write ///< Read and Write
+ Read, ///< Read-only
+ Write ///< Read and Write
+ };
+
+ /**
+ The standard registry key enumerator.
+ */
+ enum StdKey
+ {
+ HKCR, ///< HKEY_CLASSES_ROOT
+ HKCU, ///< HKEY_CURRENT_USER
+ HKLM, ///< HKEY_LOCAL_MACHINE
+ HKUSR, ///< HKEY_USERS
+ HKPD, ///< HKEY_PERFORMANCE_DATA (Windows NT and 2K only)
+ HKCC, ///< HKEY_CURRENT_CONFIG
+ HKDD, ///< HKEY_DYN_DATA (Windows 95 and 98 only)
+ HKMAX
+ };
+
+ /**
+ The value type enumerator.
+ */
+ enum ValueType
+ {
+ Type_None, ///< No value type
+ Type_String, ///< Unicode null-terminated string
+ Type_Expand_String, ///< Unicode null-terminated string
+ ///< (with environment variable references)
+ Type_Binary, ///< Free form binary
+ Type_Dword, ///< 32-bit number
+ Type_Dword_little_endian, ///< 32-bit number (same as Type_Dword)
+ Type_Dword_big_endian, ///< 32-bit number
+ Type_Link, ///< Symbolic Link (Unicode)
+ Type_Multi_String, ///< Multiple Unicode strings
+ Type_Resource_list, ///< Resource list in the resource map
+ Type_Full_resource_descriptor, ///< Resource list in the hardware description
+ Type_Resource_requirements_list ///<
};
/**
*/
void Close();
+ /**
+ Copy the entire contents of the key recursively to another location
+ using the name.
+ */
+ bool Copy(const wxString& szNewName);
+ /**
+ Copy the entire contents of the key recursively to another location
+ using the key.
+ */
+ bool Copy(wxRegKey& keyDst);
+
+ /**
+ Copy the value to another key, possibly changing its name. By default
+ it will remain the same.
+ */
+ bool CopyValue(const wxString& szValue, wxRegKey& keyDst,
+ const wxString& szNewName = wxEmptyString);
/**
Creates the key. Will fail if the key already exists and @a bOkIfExists is
@false.
/**
Deletes the subkey with all of its subkeys/values recursively.
*/
- void DeleteKey(const wxChar* szKey);
+ void DeleteKey(const wxString& szKey);
/**
Deletes this key and all of its subkeys and values recursively.
/**
Deletes the named value.
*/
- void DeleteValue(const wxChar* szKey);
+ void DeleteValue(const wxString& szKey);
/**
Returns @true if the key exists.
*/
bool Exists() const;
+ /**
+ Write the contents of this key and all its subkeys to the given file.
+ (The file will not be overwritten; it's an error if it already exists.)
+ Note that we export the key in REGEDIT4 format, not RegSaveKey() binary
+ format nor the newer REGEDIT5.
+ */
+ bool Export(const wxString& filename) const;
+ /**
+ Write the contents of this key and all its subkeys to the opened stream.
+ */
+ bool Export(wxOutputStream& ostr) const;
+
/**
Gets the first key.
*/
*/
bool GetNextValue(wxString& strValueName, long& lIndex) const;
+ /**
+ Gets the value type.
+ */
+ ValueType GetValueType(const wxString& szValue) const;
+
/**
Returns @true if given subkey exists.
*/
- bool HasSubKey(const wxChar* szKey) const;
+ bool HasSubKey(const wxString& szKey) const;
/**
Returns @true if any subkeys exist.
/**
Returns @true if the value exists.
*/
- bool HasValue(const wxChar* szValue) const;
+ bool HasValue(const wxString& szValue) const;
/**
Returns @true if any values exist.
*/
bool IsEmpty() const;
+ /**
+ Returns true if the value contains a number.
+ */
+ bool IsNumericValue(const wxString& szValue) const;
+
/**
Returns @true if the key is opened.
*/
bool Open(AccessMode mode = Write);
/**
- Retrieves the string value.
+ Return the default value of the key.
+ */
+ wxString QueryDefaultValue() const;
+
+ /**
+ Retrieves the raw string value.
*/
- bool QueryValue(const wxChar* szValue, wxString& strValue) const;
+ bool QueryRawValue(const wxString& szValue, wxString& strValue) const;
+
+ /**
+ Retrieves the raw or expanded string value.
+ */
+ bool QueryValue(const wxString& szValue, wxString& strValue, bool raw) const;
/**
Retrieves the numeric value.
*/
- const bool QueryValue(const wxChar* szValue, long* plValue) const;
+ bool QueryValue(const wxString& szValue, long* plValue) const;
+
+ /**
+ Retrieves the binary structure.
+ */
+ bool QueryValue(const wxString& szValue, wxMemoryBuffer& buf) const;
/**
Renames the key.
*/
- bool Rename(const wxChar* szNewName);
+ bool Rename(const wxString& szNewName);
/**
Renames a value.
*/
- bool RenameValue(const wxChar* szValueOld,
- const wxChar* szValueNew);
+ bool RenameValue(const wxString& szValueOld,
+ const wxString& szValueNew);
+ /**
+ Preallocate some memory for the name. For wxRegConfig usage only.
+ */
+ void ReserveMemoryForName(size_t bytes);
+
+ /**
+ Set or change the HKEY handle.
+ */
+ void SetHkey(WXHKEY hKey);
+
+ /**
+ Set the full key name. The name is absolute. It should start with
+ HKEY_xxx.
+ */
+ void SetName(const wxString& strKey);
+ /**
+ Set the name relative to the parent key
+ */
+ void SetName(StdKey keyParent, const wxString& strKey);
+ /**
+ Set the name relative to the parent key
+ */
+ void SetName(const wxRegKey& keyParent, const wxString& strKey);
+
/**
Sets the given @a szValue which must be numeric.
If the value doesn't exist, it is created.
*/
- bool SetValue(const wxChar* szValue, long lValue);
+ bool SetValue(const wxString& szValue, long lValue);
/**
Sets the given @a szValue which must be string.
If the value doesn't exist, it is created.
*/
- bool SetValue(const wxChar* szValue, const wxString& strValue);
+ bool SetValue(const wxString& szValue, const wxString& strValue);
/**
Sets the given @a szValue which must be binary.
If the value doesn't exist, it is created.
*/
- bool SetValue(const wxChar* szValue, const wxMemoryBuffer& buf);
+ bool SetValue(const wxString& szValue, const wxMemoryBuffer& buf);
};
projects / wxWidgets.git / blobdiff