Click here to Skip to main content
Click here to Skip to main content

User-settings class for ATL/WTL projects

, 3 Apr 2001
Rate this:
Please Sign up or sign in to vote.
A helper class for storing user settings in the Registry, similar to MFC's CWinApp
<!-- Link to source file download --> <!-- Add the rest of your HTML here -->

User-settings class for ATL/WTL Projects

WTL is a great framework for putting together small, lightweight applications, but I miss some of the helpful features of MFC. One of these is the ability to save user settings in the registry. So I made this class to save me the hassle of calling the registry API by hand. All you need to do is derive your main user-interface class (either your frame window or view) from CAppSettings, like so:

class CMainFrame : public CAppSettings, CFrameWindowImpl<CMainFrame>, ...

After that, one call to specify the name of the key your settings will be stored under and you're away. You can set and retrieve strings, DWORDs and structs, and they can be stored under HKEY_LOCAL_MACHINE or HKEY_CURRENT_USER. In either case, your settings will be stored in a subkey of Software.

Functions

Use this function to specify the root key for your settings. Typically you will want to use something like "companyname\\appname".

  • void SetRegKey(LPCTSTR lpszKey)

Use these functions for storing values in the registry. Replace XXX with "Machine" or "User", depending on whether you want them stored under HKEY_LOCAL_MACHINE or HKEY_CURRENT_USER. In each of the functions below, lpszSection is the name of a further subkey which will be added to the string you specified in SetRegKey. So the entire key path will look like this: [HKLM / HKCU]\Software\keyname\section name\value

  • BOOL WriteXXXProfileDword(LPCTSTR lpszSection, LPCTSTR lpszEntry, DWORD dwVal)
  • BOOL WriteXXXProfileString(LPCTSTR lpszSection, LPCTSTR lpszEntry, LPCTSTR lpszVal)
  • template <class T> BOOL WriteXXXProfileStruct(LPCTSTR lpszSection, LPCTSTR lpszEntry, T& obj)

Use these functions to retrieve a value from the registry, or a default value if it isn't there. The function to store a user-defined struct cannot retrieve a default value, and only returns TRUE or FALSE to indicate whether or not the call succeeded.

  • DWORD GetXXXProfileDword(LPCTSTR lpszSection, LPCTSTR lpszEntry, DWORD dwDefault = 0)
  • CString GetXXXProfileString(LPCTSTR lpszSection, LPCTSTR lpszEntry, LPCTSTR lpszDefault = NULL)
  • template <class T> BOOL GetXXXProfileStruct(LPCTSTR lpszSection, LPCTSTR lpszEntry, T& obj)

That's it! I hope you find it useful.

License

This article has no explicit license attached to it but may contain usage terms in the article text or the download files themselves. If in doubt please contact the author via the discussion board below.

A list of licenses authors might use can be found here

About the Author

Peter Kenyon
Web Developer
New Zealand New Zealand
No Biography provided

Comments and Discussions

 
GeneralUpdated for VC++ .NET Pinmembernegotiator22-Jun-03 19:50 
GeneralRe: Updated for VC++ .NET PinmemberRob Staveley7-May-04 2:14 
GeneralMFC PinmemberAnonymous2-Oct-01 0:27 
GeneralOoouuuccchhh PinmemberTomaz Stih4-Mar-01 23:33 
Peter,
 
Using inheritance in a way you do in C++ means establishing IS-A relationship. This means that your main frame is an app setting. Nedless to say, this is extremely ugly, plus you use multiple inheritance.
 
Instead you should use HAS-A relationship and bind it to your application, not your main frame.
 
I had this neat idea about implementing registry values based on templates (if anyone cares to play with it?). Compliant with ATL/WTL philosophy one could have
something like:
 
UserSetting iNrOfOpenedWindows;
MachineSetting sCustomerIdForAutoUpdate;
 
Then one could say iNrOfOpenedWindows=1 (treat it as integer) and iNrOfOpenedWindows.Save("MyCompanyName/MyAppKey"). You could provide different Save/Load pre-implementations for some known types using C++ traits...
 
Advantage: when using generic names such as UserSetting, MachineSetting you're not coupling the implementation and Microsoft's technologies.
 
Another possible implementation would be using streams. Something like
 
regstream rs;
rs << value("keyname","valuename",10);
 
or using manipulators:
 
rs >> setregpos("keyname","valuename") >> i >> j;
 
Tomaz
 
Tomaz Stih, B.Sc.SE
GeneralRe: Ooouuuccchhh - damn parser ate most important characters PinmemberTomaz Stih4-Mar-01 23:36 
GeneralRe: Ooouuuccchhh PinmemberPeter Kenyon5-Mar-01 11:57 
GeneralRe: Ooouuuccchhh PinmemberTomaz Stih5-Mar-01 23:52 
GeneralRe: Ooouuuccchhh PinmemberPeter Kenyon6-Mar-01 11:51 
QuestionArchaic? Pinsussdbj22-Aug-00 10:03 
AnswerRe: Archaic? PinsussPeter31-Aug-00 19:11 
AnswerRe: Archaic? Pinsussaaa28-Oct-00 10:54 
GeneralHas a dependency on CString PinsussPeter Kenyon6-Jul-00 20:02 

General General    News News    Suggestion Suggestion    Question Question    Bug Bug    Answer Answer    Joke Joke    Rant Rant    Admin Admin   

Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads, Ctrl+Shift+Left/Right to switch pages.

| Advertise | Privacy | Mobile
Web04 | 2.8.140709.1 | Last Updated 4 Apr 2001
Article Copyright 2000 by Peter Kenyon
Everything else Copyright © CodeProject, 1999-2014
Terms of Service
Layout: fixed | fluid