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

Ini Handler

, 2 Jun 2004
Rate this:
Please Sign up or sign in to vote.
Permits simple access to ini files

Introduction

This class (IniHandler) permits Ini file access. The class represents the contents of the ini, and has functions to list, add, remove and rename categories (they would rather be sections, but ... whatever), and can list, create, delete, and modify key-value pairs. The class has static methods to read and write files.

Using the code

The only class is the IniHandler class in which everything is implemented. It does not write every change directly to the file. You rather get all data, then modify it, and at last save it.

The first part handles all the structure:

All data is saved in one System.Collections.SortedList which contains the category names as keys, and all key-value pairs as values, saved as SortedLists too. So this means there are SortedLists in a SortedList. That behaves like an array in an array, but with dynamic bounds and strings as indexers.

I hope you did understand this, it would have been easier to explain in French or German. You can of course list all categories, and all keys in a specified category. When you want to modify or read a value, you need to specify the categoryname and the keyname only.

This code is all you need to write an ini:

IniStructure Ini = new IniStructure();
Ini.AddCategory("NewSection");
Ini.AddValue("NewSection","NewKey","value");
Ini.ModifyValue("NewSection","NewKey","Newvalue");
IniStructure.WriteIni(Ini,"c:\filename.ini","Optional \n multiline \n comment");

The ini c:\filename.ini would then contain:

# Optional
# multiline
# comment

[NewSection]
NewKey=NewValue

Each time you write, the file is cleared and rewritten from scratch.

To read an ini, it's very similar:

IniStructure Ini = IniStructure.ReadIni("C:\filename.ini");
string[] allCategories = Ini.GetCategories();

// if Global would be a category, this lists all keys:
string[] keysInGlobal = Ini.GetKeys("Global");
 
// and if testkey would be a key in Global:
string testKeyValue = Ini.GetValue("Global","testkey");

There are also methods to list the categories and the key-value pairs by index, but they are only used to iterate through all categories and keys during saving.

Points of Interest

It's the first time I use SortedLists, and first tried to write this without them, but I'm happy that I found them because it makes the code a lot simpler. There are some things to do, like error handling: because most methods only return bool, you can only know if an error occurred, but no more. Things like incorrect names (no '=', '[', ']' ... in category names etc..) are handled, but that's all. There's sure room for improvement, but, that's always the case, isn't it?

History

  • April 17th : First version.
  • May 29th : Bugfix - IniStructure.ReadIni(string) can now read read-only ini files because it opens the file with the FileAccess.Read param.

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

kratchkov

Switzerland Switzerland
I left the Microsoft world, and am now working with linux and a BSD. This switch was a big relief, mostly for my keyboard, which doesn't get slammed again.
 
A big thank you to those who helped me with their good articles.

Comments and Discussions

 
Questionsections bug PinmemberMember 770255324-Feb-11 7:02 
GeneralDeleteCategory doesn't work to me PinmembercH40z-Lord9-Oct-07 2:22 
Hey,
 
your lib is really great, I love it!
 
But I got one issue with your lib - it doesn't delete a category.
 
I tried it with ::
 
IniStructure Ini = IniStructure.ReadIni(inipath);
Ini.DeleteCategory("Test");
 
And Test is the name of the category with 1 key and 1 value - but after reaching this line the category even exist in my .ini file
GeneralNini PinmemberMattman2061-Aug-06 11:37 
Generalencoding problem. Pinmembermargiex27-Feb-06 16:17 
GeneralSorting PinmemberCemeron31-Jan-06 11:39 
GeneralTiny bugfix PinmemberRolf Therkildsen16-Aug-05 20:37 
QuestionAnother version without SortedList??? PinmemberWayneC3-May-05 22:05 
Generaldownload error PinsussBarraq31-Jul-04 1:09 
GeneralRe: download error Pinmemberkratchkov1-Aug-04 20:38 
GeneralImprovement PinmemberAlex Rovner29-Jul-04 13:22 
GeneralRe: Improvement Pinmemberkratchkov1-Aug-04 20:38 
GeneralRe: Improvement PinmemberAlex Rovner2-Aug-04 5:34 
GeneralRe: Improvement Pinmemberkratchkov4-Aug-04 8:56 
GeneralRe: Improvement Pinmemberquintonviljoen22-Dec-04 19:38 
GeneralRe: Improvement PinmemberAndyYerg1-Mar-07 8:24 
Generalsmall mistake PinmemberFilip Geens7-Jul-04 22:00 
GeneralRe: small mistake Pinmemberlokeshdeshmukh15-Jun-08 23:33 
GeneralForm PinmemberFilip Geens7-Jul-04 21:41 
GeneralRe: Form Pinmemberkratchkov8-Jul-04 10:10 

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 3 Jun 2004
Article Copyright 2004 by kratchkov
Everything else Copyright © CodeProject, 1999-2014
Terms of Service
Layout: fixed | fluid