cheng/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Document the meaning of empty value name in wxRegKey methods.

Browse Source 
Empty value refers to the default or unnamed key in Win32 API but this may be
not clear to people unused to it so mention this explicitly.

Closes #11191.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@61899 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Vadim Zeitlin 2009-09-12 22:48:29 +00:00
parent 227989f3e9
commit 3a326bfe02
1 changed files with 7 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
interface/wx/msw/registry.h
View File

@ -293,21 +293,25 @@ public:
/**
Retrieves the raw string value. Returns @true if successful.
An empty @a szValue queries the default/unnamed key value.
*/
bool QueryRawValue(const wxString& szValue, wxString& strValue) const;
/**
Retrieves the raw or expanded string value. Returns @true if successful.
An empty @a szValue queries the default/unnamed key value.
*/
bool QueryValue(const wxString& szValue, wxString& strValue, bool raw) const;
/**
Retrieves the numeric value. Returns @true if successful.
An empty @a szValue queries the default/unnamed key value.
*/
bool QueryValue(const wxString& szValue, long* plValue) const;
/**
Retrieves the binary structure. Returns @true if successful.
An empty @a szValue queries the default/unnamed key value.
*/
bool QueryValue(const wxString& szValue, wxMemoryBuffer& buf) const;
@ -349,16 +353,19 @@ public:
/**
Sets the given @a szValue which must be numeric. If the value doesn't
exist, it is created. Returns @true if successful.
An empty @a szValue sets the default/unnamed key value.
*/
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. Returns @true if successful.
An empty @a szValue sets the default/unnamed key value.
*/
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. Returns @true if successful.
An empty @a szValue sets the default/unnamed key value.
*/
bool SetValue(const wxString& szValue, const wxMemoryBuffer& buf);
};