diff options
| author | tfarina@chromium.org <tfarina@chromium.org@0039d316-1c4b-4281-b951-d872f2087c98> | 2011-10-23 02:36:47 +0000 |
|---|---|---|
| committer | tfarina@chromium.org <tfarina@chromium.org@0039d316-1c4b-4281-b951-d872f2087c98> | 2011-10-23 02:36:47 +0000 |
| commit | 39dc9d7cbf2654987a8fc3c658cf69239080d185 (patch) | |
| tree | 476e6f41bcb4482825b3648255736a8b3c29ee35 /base/win/registry.h | |
| parent | 726843ee7169596c9876cba277d1eaa0ee754ef4 (diff) | |
| download | chromium_src-39dc9d7cbf2654987a8fc3c658cf69239080d185.zip chromium_src-39dc9d7cbf2654987a8fc3c658cf69239080d185.tar.gz chromium_src-39dc9d7cbf2654987a8fc3c658cf69239080d185.tar.bz2 | |
base/win: Add documentation to RegKey::Read/Write functions.
R=maruel@chromium.org,willchan@chromium.org,grt@chromium.org
Review URL: http://codereview.chromium.org/8344004
git-svn-id: svn://svn.chromium.org/chrome/trunk/src@106869 0039d316-1c4b-4281-b951-d872f2087c98
Diffstat (limited to 'base/win/registry.h')
| -rw-r--r-- | base/win/registry.h | 38 |
1 files changed, 31 insertions, 7 deletions
diff --git a/base/win/registry.h b/base/win/registry.h index 33052ff..9bc1576 100644 --- a/base/win/registry.h +++ b/base/win/registry.h @@ -66,16 +66,40 @@ class BASE_EXPORT RegKey { // Deletes a single value within the key. LONG DeleteValue(const wchar_t* name); - LONG ReadValue(const wchar_t* name, void* data, DWORD* dsize, + // Getters: + + // Returns an int32 value. If |name| is NULL or empty, returns the default + // value, if any. + LONG ReadValueDW(const wchar_t* name, DWORD* out_value) const; + + // Returns an int64 value. If |name| is NULL or empty, returns the default + // value, if any. + LONG ReadInt64(const wchar_t* name, int64* out_value) const; + + // Returns a string value. If |name| is NULL or empty, returns the default + // value, if any. + LONG ReadValue(const wchar_t* name, std::wstring* out_value) const; + + // Returns raw data. If |name| is NULL or empty, returns the default + // value, if any. + LONG ReadValue(const wchar_t* name, + void* data, + DWORD* dsize, DWORD* dtype) const; - LONG ReadValue(const wchar_t* name, std::wstring* value) const; - LONG ReadValueDW(const wchar_t* name, DWORD* value) const; - LONG ReadInt64(const wchar_t* name, int64* value) const; - LONG WriteValue(const wchar_t* name, const void* data, DWORD dsize, + // Setters: + + // Sets an int32 value. + LONG WriteValue(const wchar_t* name, DWORD in_value); + + // Sets a string value. + LONG WriteValue(const wchar_t* name, const wchar_t* in_value); + + // Sets raw data, including type. + LONG WriteValue(const wchar_t* name, + const void* data, + DWORD dsize, DWORD dtype); - LONG WriteValue(const wchar_t* name, const wchar_t* value); - LONG WriteValue(const wchar_t* name, DWORD value); // Starts watching the key to see if any of its values have changed. // The key must have been opened with the KEY_NOTIFY access privilege. |