// Name: msw/registry.h
// Purpose: Registry classes and functions
// Author: Vadim Zeitlin
-// Modified by:
+// Modified by:
// Created: 03.04.198
// RCS-ID: $Id$
// Copyright: (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
// (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_little_endian // 32-bit number
+ = Type_Dword, // (same as Type_DWORD)
Type_Dword_big_endian, // 32-bit number
Type_Link, // Symbolic Link (unicode)
Type_Multi_String, // Multiple Unicode strings
// predefined registry keys
enum StdKey
{
- HKCR // classes root
+ HKCR // classes root
#ifdef __WIN32__
- , HKCU, // current user
- HKLM, // local machine
- HKUSR, // users
- HKPD // performance data (@@ NT only?)
-#if WINVER >= 0x0400
- , HKCC, // current config
- HKDD // dynamic data
+ ,
+ HKCU, // current user
+ HKLM, // local machine
+ HKUSR, // users
+ HKPD // performance data (WinNT/2K only)
+#if WINVER >= 0x0400
+ ,
+ HKCC, // current config (starting from Win95/NT 4.0)
+ HKDD // dynamic data (Win95/98 only)
#endif // Winver
#endif // Win32/16
};
// number of standard keys
static const size_t nStdKeys;
// get the name of a standard key
- static const char *GetStdKeyName(size_t key);
+ static const wxChar *GetStdKeyName(size_t key);
// get the short name of a standard key
- static const char *GetStdKeyShortName(size_t key);
+ static const wxChar *GetStdKeyShortName(size_t key);
// get StdKey from root HKEY
static StdKey GetStdKeyFromHkey(WXHKEY hkey);
// return true if the key exists
bool Exists() const;
// get the info about key (any number of these pointers may be NULL)
-
-#ifdef __GNUWIN32__
bool GetKeyInfo(size_t *pnSubKeys, // number of subkeys
size_t *pnMaxKeyLen, // max len of subkey name
size_t *pnValues, // number of values
size_t *pnMaxValueLen) const;
-#else
- bool GetKeyInfo(ulong *pnSubKeys, // number of subkeys
- ulong *pnMaxKeyLen, // max len of subkey name
- ulong *pnValues, // number of values
- ulong *pnMaxValueLen) const;
-#endif
// return true if the key is opened
bool IsOpened() const { return m_hKey != 0; }
// for "if ( !key ) wxLogError(...)" kind of expressions
// explicitly open the key (will be automatically done by all functions
// which need the key to be opened if the key is not opened yet)
bool Open();
- // create the key: will fail if the key already exists and bOkIfExists
+ // create the key: will fail if the key already exists and !bOkIfExists
bool Create(bool bOkIfExists = TRUE);
+ // rename a value from old name to new one
+ bool RenameValue(const wxChar *szValueOld, const wxChar *szValueNew);
+ // copy value to another key possibly changing its name (by default it will
+ // remain the same)
+ bool CopyValue(const wxChar *szValue, wxRegKey& keyDst,
+ const wxChar *szNewName = NULL);
+ // copy the entire contents of the key recursively to another location
+ bool Copy(const wxString& strNewName);
+ // same as Copy() but using a key and not the name
+ bool Copy(wxRegKey& keyDst);
// close the key (will be automatically done in dtor)
bool Close();
// deletes this key and all of it's subkeys/values
bool DeleteSelf();
// deletes the subkey with all of it's subkeys/values recursively
- bool DeleteKey(const char *szKey);
+ bool DeleteKey(const wxChar *szKey);
// deletes the named value (may be NULL to remove the default value)
- bool DeleteValue(const char *szValue);
+ bool DeleteValue(const wxChar *szValue);
// access to values and subkeys
// get value type
- ValueType GetValueType(const char *szValue) const;
+ ValueType GetValueType(const wxChar *szValue) const;
// returns TRUE if the value contains a number (else it's some string)
- bool IsNumericValue(const char *szValue) const;
+ bool IsNumericValue(const wxChar *szValue) const;
// assignment operators set the default value of the key
wxRegKey& operator=(const wxString& strValue)
operator wxString() const;
// set the string value
- bool SetValue(const char *szValue, const wxString& strValue);
+ bool SetValue(const wxChar *szValue, const wxString& strValue);
// return the string value
- bool QueryValue(const char *szValue, wxString& strValue) const;
+ bool QueryValue(const wxChar *szValue, wxString& strValue) const;
#ifdef __WIN32__
// set the numeric value
- bool SetValue(const char *szValue, long lValue);
+ bool SetValue(const wxChar *szValue, long lValue);
// return the numeric value
- bool QueryValue(const char *szValue, long *plValue) const;
+ bool QueryValue(const wxChar *szValue, long *plValue) const;
#endif //Win32
// query existence of a key/value
// return true if value exists
- bool HasValue(const char *szKey) const;
+ bool HasValue(const wxChar *szKey) const;
// return true if given subkey exists
- bool HasSubKey(const char *szKey) const;
+ bool HasSubKey(const wxChar *szKey) const;
// return true if any subkeys exist
- bool HasSubkeys() const;
+ bool HasSubkeys() const;
+ // return true if any values exist
+ bool HasValues() const;
+ // return true if the key is empty (nothing under this key)
+ bool IsEmpty() const { return !HasSubkeys() && !HasValues(); }
// enumerate values and subkeys
bool GetFirstValue(wxString& strValueName, long& lIndex);
projects / wxWidgets.git / blobdiff