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

CIniFile

, 31 May 2005
Rate this:
Please Sign up or sign in to vote.
A class that makes it easy to implement an INI settings file in your applications.

Sample Image - cinifile.gif

Introduction

In every program I have written, I end up using some sort of INI file to keep settings from one run to the next. Instead of implementing it separately in each program, I finally got around to writing this class, CIniFile. It is simple to set up and use.

After you create your CIniFile object, call the member function SetPath(CString newpath) to set the path/filename for the INI file to read from and write to.

To read the INI file data into the class, call ReadFile().

To retrieve data from the class, use GetValue or one of its overloads:

//returns value of keyname/valuename as CString
CString GetValue(CString keyname, CString valuename);

//returns value of keyname/valuename as int
int GetValueI(CString keyname, CString valuename);
 
//returns value of keyname/valuename as double
double GetValueF(CString keyname, CString valuename);

To set data values in the class, call SetValue or one of its overloads:

bool SetValue(CString key, CString valuename, CString value, bool create = 1); 
bool SetValueI(CString key, CString valuename, int value, bool create = 1);
bool SetValueF(CString key, CString valuename, double value, bool create = 1);

Use the optional parameter create as false if you do not want it to create the key/value if it doesn't already exist.

SetValue returns TRUE if the value was successfully stored, FALSE otherwise.

To delete a value from the class, call DeleteValue(CString keyname, CString valuename). This function will return TRUE if the value is deleted, FALSE otherwise.

To delete an entire key from the class, call DeleteKey(CString keyname). This function will return TRUE if the key is deleted, FALSE otherwise.

To remove all data stored in the class, call Reset().

Other useful functions are GetNumKeys() which returns the number of keys in the INI file and GetNumValues(CString keyname) which returns the number of values stored in the specified key.

Finally, to write all your stored data to the specified INI file, call WriteFile().

That's it! It is simple.

Email comments to cabadam@tamu.edu.

Updates

  • 5 May 2000

    Updated source and demo files.

  • 2 March 2003

    It has been a long time since I've looked at this article, but as there has been a lot of interest in the non-MFC version of this class, I decided to go ahead and upload it here. As the non-MFC version, rewritten by Shane Hill, contains many more features, I've decided to remove the original MFC class from here. This means a couple things. First - the demo picture at the top of this article is wrong. There are no spaces surrounding the '=' sign. Also, even though the class contains many more features, the basic operation of the class remains the same for the most part. New features include the ability to enumerate existing keys and values and to add comments into the INI file. For the new additions, see the well documented header file.

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

Cabadam
Web Developer
United States United States
No Biography provided

Comments and Discussions

 
GeneralKey to CString PinmemberNightBlade19-Sep-02 13:23 
GeneralRe: Key to CString PinmemberAdam Clauss19-Sep-02 15:00 
GeneralRe: Key to CString PinmemberNightBlade19-Sep-02 16:34 
GeneralGreat Class PinsussPaulMcD19-Sep-02 3:08 
GeneralCompatibility NT / 9X Pinsusstut4-Sep-02 5:47 
GeneralRe: Compatibility NT / 9X PinmemberAdam Clauss4-Sep-02 6:31 
GeneralRe: Compatibility NT / 9X PinmemberJ Cardinal18-Nov-02 12:09 
QuestionWhy don't you use existing API calls(Non-MFC)? PinmemberBin8-Jul-02 19:11 
AnswerRe: Why don't you use existing API calls(Non-MFC)? PinmemberAdam Clauss9-Jul-02 1:24 
GeneralRe: Why don't you use existing API calls(Non-MFC)? PinmemberAdam Clauss9-Jul-02 1:58 
GeneralRe: Why don't you use existing API calls(Non-MFC)? PinmemberBin27-Aug-02 5:31 
GeneralRe: Why don't you use existing API calls(Non-MFC)? PinmemberAdam Clauss27-Aug-02 6:14 
GeneralRe: Why don't you use existing API calls(Non-MFC)? PinmemberBin27-Aug-02 6:23 
GeneralRe: Why don't you use existing API calls(Non-MFC)? PinmemberAdam Clauss27-Aug-02 6:38 
Hehe, its ok.
I suppose mostly whether you use a clas like mine or the Win32 API is just a personal preference. If you only develop on Win32 (which is true in my case), it really doesn't matter much which one you use. Either will get the job done.
 
When I originally wrote this class, I wrote it more of as an excercise for myself. I was not at all familiar with the STL yet, only MFC. After writing it, I realized it was actually a fairly useful class and decided to post it here.
 
Adam Clauss
cabadam@tamu.edu
GeneralRe: Why don't you use existing API calls(Non-MFC)? PinmemberPaul Oss1-Nov-02 10:19 
GeneralContents of the inifile. PinmemberEmma25-Mar-02 5:15 
GeneralRe: Contents of the inifile. PinmemberAdam Clauss25-Mar-02 7:27 
GeneralRe: Contents of the inifile. PinmemberEmma26-Mar-02 3:49 
GeneralRe: Contents of the inifile. PinmemberAdam Clauss26-Mar-02 9:13 
GeneralRe: Contents of the inifile. PinsussPeter, the pumpkin eater5-Aug-02 12:02 
GeneralRe: Contents of the inifile. PinmemberSREERAMULU7-Mar-03 19:12 
GeneralIf You Are Looking Non-MFC Code... PinmemberAdam Clauss4-Mar-02 11:05 
GeneralNon MFC code PinmemberRay Romero15-Feb-02 7:43 
GeneralSorting and Searech the Keys+Values PinmemberDuncan Weir30-Jan-02 0:49 
GeneralRe: Sorting and Searech the Keys+Values PinmemberZhuoGuangSheng7-May-03 7:52 
GeneralClass if not very good at parsing "non-common" INI's (and it doesn't ignores remarks!!!) PinmemberAnonymous10-Sep-01 8:40 
GeneralRe: Class if not very good at parsing "non-common" INI's (and it doesn't ignores remarks!!!) PinmemberAnonymous3-Apr-02 6:30 
GeneralCIniFile class with MFC Removed PinmemberShane20-Aug-01 22:02 
GeneralLink errors Pinmemberdereks19-Aug-01 3:27 
GeneralRe: Link errors PinmemberMicha19-Aug-01 23:57 
GeneralRe: Link errors PinmemberAnonymous24-May-02 21:08 
GeneralCIniFile and Linux/Unix PinmemberShane16-Aug-01 20:33 
GeneralRe: CIniFile and Linux/Unix Pinmembermarkkuk16-Aug-01 20:42 
GeneralRe: CIniFile and Linux/Unix PinmemberShane16-Aug-01 21:13 
GeneralRe: CIniFile and Linux/Unix PinmemberTodd Smith16-Aug-01 21:25 
GeneralRe: CIniFile and Linux/Unix PinmemberShane17-Aug-01 22:58 
GeneralFunction Overloading PinmemberAnonymous2-Aug-01 10:13 
QuestionHow about in C PinmemberAnonymous25-May-01 5:52 
AnswerRe: How about in C PinmemberCarlos Antollini25-May-01 6:13 
GeneralRe: How about in C PinmemberAnonymous3-Jun-01 17:30 
GeneralRe: How about in C PinmemberAnonymous2-Jul-01 21:20 
GeneralMemory leak! PinmemberAnonymous8-May-01 0:41 
GeneralTrimLeft and TrimRight PinmemberPhil C23-Feb-01 13:20 
GeneralUpdate INI PinmemberEs Jayes17-Nov-00 15:16 
GeneralRe: Update INI PinmemberNicolas De Rycke28-Dec-00 5:38 
Questiondefault values for CEdit? PinsussPedro Rocha19-Oct-00 7:15 
AnswerRe: default values for CEdit? PinsussAdam Clauss19-Oct-00 11:10 
GeneralCString vc CEdit PinsussPedro Rocha19-Oct-00 5:00 
GeneralRe: CString vc CEdit PinsussAdam Clauss19-Oct-00 11:09 
QuestionWhy change the naming convention? PinsussJason12-May-00 10:58 

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 | Terms of Use | Mobile
Web03 | 2.8.1411023.1 | Last Updated 31 May 2005
Article Copyright 2000 by Cabadam
Everything else Copyright © CodeProject, 1999-2014
Layout: fixed | fluid