Click here to Skip to main content
15,867,453 members
Articles / Desktop Programming / MFC
Article

Save Application Settings to XML

Rate me:
Please Sign up or sign in to vote.
3.92/5 (5 votes)
16 Sep 20022 min read 256.4K   1.8K   54   77
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


Written By
Software Developer (Senior)
United States United States
I have been a professional developer since 1996. I live in Illinois, in the USA. I am married and have four children.

Comments and Discussions

 
GeneralRe: Kill this article. Pin
Nish Nishant21-Apr-06 11:49
sitebuilderNish Nishant21-Apr-06 11:49 
GeneralSpecify your language, please !! Pin
Fred Koschara1-Nov-05 1:22
professionalFred Koschara1-Nov-05 1:22 
GeneralRe: Specify your language, please !! Pin
Jason Henderson1-Nov-05 2:57
Jason Henderson1-Nov-05 2:57 
GeneralRe: Specify your language, please !! Pin
Nish Nishant21-Apr-06 11:42
sitebuilderNish Nishant21-Apr-06 11:42 
GeneralRe: Specify your language, please !! Pin
Nish Nishant21-Apr-06 11:49
sitebuilderNish Nishant21-Apr-06 11:49 
GeneralRe: Save Application Settings to XML Pin
Jason Henderson20-Dec-06 2:40
Jason Henderson20-Dec-06 2:40 
GeneralRe: Save Application Settings to XML Pin
Nish Nishant20-Dec-06 2:43
sitebuilderNish Nishant20-Dec-06 2:43 
GeneralRe: Save Application Settings to XML Pin
Jason Henderson20-Dec-06 2:48
Jason Henderson20-Dec-06 2:48 
GeneralRe: Specify your language, please !! Pin
ziopino7013-Apr-10 21:06
ziopino7013-Apr-10 21:06 
GeneralNo More CXMLSettings Class Pin
Nicolas DUFAUT12-Feb-05 22:15
Nicolas DUFAUT12-Feb-05 22:15 
GeneralRe: No More CXMLSettings Class Pin
Jason Henderson13-Feb-05 18:13
Jason Henderson13-Feb-05 18:13 
GeneralRe: No More CXMLSettings Class Pin
Nicolas DUFAUT13-Feb-05 19:17
Nicolas DUFAUT13-Feb-05 19:17 
GeneralRe: No More CXMLSettings Class Pin
prcarp23-Aug-05 3:01
prcarp23-Aug-05 3:01 
GeneralRe: No More CXMLSettings Class Pin
Jason Henderson23-Aug-05 3:20
Jason Henderson23-Aug-05 3:20 
GeneralRe: No More CXMLSettings Class Pin
Jason Henderson20-Dec-06 2:39
Jason Henderson20-Dec-06 2:39 
GeneralRe: No More CXMLSettings Class Pin
prcarp20-Dec-06 2:54
prcarp20-Dec-06 2:54 
GeneralRe: No More CXMLSettings Class Pin
Jason Henderson20-Dec-06 3:06
Jason Henderson20-Dec-06 3:06 
GeneralCoInitialize(NULL) Pin
Slawa6-May-03 5:52
Slawa6-May-03 5:52 
GeneralRe: CoInitialize(NULL) Pin
Jason Henderson6-May-03 7:03
Jason Henderson6-May-03 7:03 
GeneralI love it for MY needs! Pin
Paul Kissel4-Apr-03 9:46
Paul Kissel4-Apr-03 9:46 
GeneralRe: I love it for MY needs! Pin
Jason Henderson4-Apr-03 9:57
Jason Henderson4-Apr-03 9:57 
Generalattributes Pin
Jesper Odgaard Nielsen26-Mar-03 2:38
Jesper Odgaard Nielsen26-Mar-03 2:38 
GeneralRe: attributes Pin
Jason Henderson4-Apr-03 9:56
Jason Henderson4-Apr-03 9:56 
GeneralIsolated Storage - Out of the Registry Pin
Neville Franks20-Sep-02 14:38
Neville Franks20-Sep-02 14:38 
GeneralNice Article Pin
Anonymous20-Sep-02 3:19
Anonymous20-Sep-02 3:19 

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

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