Click here to Skip to main content
Licence 
First Posted 29 Jun 2000
Views 79,887
Bookmarked 38 times

User-settings class for ATL/WTL projects

By | 3 Apr 2001 | Article
A helper class for storing user settings in the Registry, similar to MFC's CWinApp

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

Member



Sign Up to vote   Poor Excellent
Add a reason or comment to your vote: x
Votes of 3 or less require a comment

Comments and Discussions

 
You must Sign In to use this message board. (secure sign-in)
 
Search this forum  
 FAQ
    Noise  Layout  Per page   
  Refresh
GeneralUpdated for VC++ .NET Pinmembernegotiator19:50 22 Jun '03  
GeneralRe: Updated for VC++ .NET PinmemberRob Staveley2:14 7 May '04  
GeneralMFC PinmemberAnonymous0:27 2 Oct '01  
GeneralOoouuuccchhh PinmemberTomaz Stih23:33 4 Mar '01  
GeneralRe: Ooouuuccchhh - damn parser ate most important characters PinmemberTomaz Stih23:36 4 Mar '01  
GeneralRe: Ooouuuccchhh PinmemberPeter Kenyon11:57 5 Mar '01  
GeneralRe: Ooouuuccchhh PinmemberTomaz Stih23:52 5 Mar '01  
GeneralRe: Ooouuuccchhh PinmemberPeter Kenyon11:51 6 Mar '01  
QuestionArchaic? Pinsussdbj10:03 22 Aug '00  
AnswerRe: Archaic? PinsussPeter19:11 31 Aug '00  
AnswerRe: Archaic? Pinsussaaa10:54 28 Oct '00  
GeneralHas a dependency on CString PinsussPeter Kenyon20:02 6 Jul '00  

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.

Permalink | Advertise | Privacy | Mobile
Web03 | 2.5.120517.1 | Last Updated 4 Apr 2001
Article Copyright 2000 by Peter Kenyon
Everything else Copyright © CodeProject, 1999-2012
Terms of Use
Layout: fixed | fluid