Click here to Skip to main content
Click here to Skip to main content
Go to top

Save Application Settings to XML

, 16 Sep 2002
Rate this:
Please Sign up or sign in to vote.
An easy to use class that reads, writes and deletes app settings to an XML file.

Introduction

Why another application settings XML class?

  1. Because INI files are so Win16.
  2. The registry is too big and you could really screw something up messing with it.
  3. XML seems to be the popular choice.

See Read and Write application parameters in XML for better reasons.

This class should make it easy to read, write and delete application settings to an XML file using the familiar registry key/value nomenclature (ex. "MyApp\Appearance\Font\Face"). If it doesn't make it easy, um... I didn't write it.

The CXMLSettings Class

To use the class, there are only 6 methods you will need to worry about.

  • void SetSettingsFile(CString cstrFile)
    • Sets the path and filename for the XML settings file.
  • long GetSettingLong(CString cstrBaseKeyName, CString cstrValueName, long lDefaultValue)
    • Returns a long value extracted from the settings file given a key and value name.
  • long SetSettingLong(CString cstrBaseKeyName, CString cstrValueName, long lValue)
    • Sets a long value in the settings file given a key and value name.
  • CString GetSettingString(CString cstrBaseKeyName, CString cstrValueName, CString cstrDefaultValue)
    • Returns a string value extracted from the settings file given a key and value name.
  • long SetSettingString(CString cstrBaseKeyName, CString cstrValueName, CString cstrValue)
    • Sets a string value in the settings file given a key and value name.
  • BOOL DeleteSetting(CString cstrBaseKeyName, CString cstrValueName)
    • Deletes a key or value from the settings file given a key and value name.

Other methods in the class parse key/value "chains", and load, save, and traverse the settings file.

How to Use It

  1. Call SetSettingsFile to tell the class where the XML file will be saved.
  2. Call one of the Get, Set or Delete methods using the registry-like nomenclature for the first parameter (ex. "MyApp\Appearance\Font"). A default value may also be sent as the last parameter to the Get methods.
  3. The DeleteSetting method can be used to delete an entire key or a value under a key.

That's it!

If the XML file does not exist or if a key/value does not exist, the Set methods will create it and the Get methods will return the default value.

Conclusion

The class and the demo app use MFC and MSXML 4.0. Please let me know if you find any bugs are would like to see improvements.

Other articles lie this one:

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

Share

About the Author

Jason Henderson
Software Developer (Senior)
United States United States
I have been a professional developer since 1996. I live in the middle of no where in Illinois, USA. I am married and have four children.

Comments and Discussions

 
GeneralNice work PinmemberDonsw8-May-09 16:18 
GeneralThanks Pinmemberislobodan6-Dec-08 15:58 
GeneralRe: Thanks Pinmemberelo12312-Dec-08 12:56 
QuestionA suggestion Pinmemberstokos20-Mar-07 2:48 
GeneralRead and save Shapes using xml in vb.net only PinmemberPrajakta Patil16-Jan-07 18:04 
GeneralRe: Read and save Shapes using xml in vb.net only PinmemberJason Henderson17-Jan-07 2:29 
QuestionRe: Read and save Shapes using xml in vb.net only PinmemberPrajakta Patil22-Jan-07 19:46 
GeneralFailure on Close Pinmember123qwertz19-Dec-06 21:38 
GeneralRe: Failure on Close PinmemberJason Henderson20-Dec-06 2:42 
GeneralKill this article. PinmemberTomM21-Apr-06 10:34 
GeneralRe: Kill this article. PinstaffNishant Sivakumar21-Apr-06 11:49 
GeneralSpecify your language, please !! PinmemberAceWizardly1-Nov-05 1:22 
GeneralRe: Specify your language, please !! PinmemberJason Henderson1-Nov-05 2:57 
GeneralRe: Specify your language, please !! PinstaffNishant Sivakumar21-Apr-06 11:42 
GeneralRe: Specify your language, please !! PinstaffNishant Sivakumar21-Apr-06 11:49 
GeneralRe: Save Application Settings to XML PinmemberJason Henderson20-Dec-06 2:40 
GeneralRe: Save Application Settings to XML PineditorNishant Sivakumar20-Dec-06 2:43 
GeneralRe: Save Application Settings to XML PinmemberJason Henderson20-Dec-06 2:48 
GeneralRe: Specify your language, please !! Pinmemberziopino7013-Apr-10 21:06 
GeneralNo More CXMLSettings Class PinmemberNicolas DUFAUT12-Feb-05 22:15 
GeneralRe: No More CXMLSettings Class PinmemberJason Henderson13-Feb-05 18:13 
GeneralRe: No More CXMLSettings Class PinmemberNicolas DUFAUT13-Feb-05 19:17 
GeneralRe: No More CXMLSettings Class Pinmemberprcarp23-Aug-05 3:01 
GeneralRe: No More CXMLSettings Class PinmemberJason Henderson23-Aug-05 3:20 
No dice. Sorry.
It's not in Google's cache either.
 
"Live long and prosper." - Spock
Jason Henderson
blog

GeneralRe: No More CXMLSettings Class PinmemberJason Henderson20-Dec-06 2:39 

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
Web02 | 2.8.140922.1 | Last Updated 17 Sep 2002
Article Copyright 2002 by Jason Henderson
Everything else Copyright © CodeProject, 1999-2014
Terms of Service
Layout: fixed | fluid