Click here to Skip to main content
15,440,620 members
Articles / Programming Languages / C#
Posted 5 Nov 2008


63 bookmarked

API-Less INI File Wrapper

Rate me:
Please Sign up or sign in to vote.
5.00/5 (24 votes)
5 Nov 2008CPOL
Read, Write, Save INI files without using Windows APIs.


Using Windows APIs to read and write (WritePrivateProfileString, GetPrivateProfileString ) INI files is easy, but if you have to get or write data on your app many times, it could cause performance issues because the functions load the INI files on each call.

So, this class will help you managing ini data on memory.


This class does not use the classical INI get or put methods. It loads an INI file on initialize, uses Regular Expressions to parse data, and uses a dictionary for managing section names and data.

Regular Expressions:

static readonly Regex regRemoveEmptyLines =
    new Regex
        RegexOptions.Multiline | RegexOptions.Compiled

static readonly Regex regParseIniData =
    new Regex
        RegexOptions.Compiled | 
        RegexOptions.IgnoreCase | 

Dictionary type:

Dictionary<string, NameValueCollection> data = 
    new Dictionary<string,NameValueCollection>();

Actually, I did not search much to see if there is something like this already. I needed it and I wrote it. And, I thought that someone might find this useful.

Using the code


//Creates an empty ini document, you can add sections,
//keys and values dynamically. And you can save it anytime.
TA_INIDocument ini = new TA_INIDocument();

//Initializes an ini file, you can change its data and save
//it anytime
TA_INIDocument ini = new TA_INIDocument("C:\\sample.ini");

//Initializes an ini file with encoding. Sometimes ini files
//could have unicode data
TA_INIDocument ini = 
    new TA_INIDocument("C:\\sample.ini", Encoding.Unicode);

//Initializes ini data from stream
Stream iniStream;
TA_INIDocument ini = new TA_INIDocument(iniStream);

//Initializes ini data from stream with encoding
Stream iniStream;
TA_INIDocument ini =
    new TA_INIDocument(iniStream, Encoding.Unicode);

Getting and setting values:

TA_INIDocument iniDoc;

//Getting key_value collection of defined section
NameValueCollection keysAndValues = iniDoc["sectionName"];
//Getting string value of defined key and section
string value = iniDoc["sectionName"]["keyName"];
string value = iniDoc["sectionName", "keyName"];
//Setting string value of defined key
iniDoc["sectionName"]["keyName"] = "newValue";
iniDoc["sectionName", "keyName"] = "newValue";
//Getting and Setting object value of defined key and section
object value = iniDoc["sectionName", "keyName", typeof(Int32)];
iniDoc["sectionName", "keyName", typeof(Rectangle)] =
    new Rectangle(0, 0, 200, 300);
//Getting and setting specific type values excepts string
//Primitive Types (included Decimal and DateTime)
//TA_INIDocument.Get{PrimitiveTypeName}(sectionName, keyName, [defaultValue])

bool bValue = 
    iniDoc.GetBoolean("sectionName", "keyName");

bool bValue = 
    iniDoc.GetBoolean("sectionName", "keyName", true);

iniDoc.SetValue("sectionName", "keyName", bValue);

DateTime dtValue = 
    iniDoc.GetDateTime("sectionName", "keyName");

DateTime dtValue = 
    iniDoc.GetDateTime("sectionName", "keyName", DateTime.MaxValue);

iniDoc.SetValue("sectionName", "keyName", dtValue);
//Other types (required that the type has TypeConverterAttribute)
//TA_INIDocument.GetValue<T>(sectionName, keyName, [T:defaultValue])

Rectangle rtValue =
    iniDoc.GetValue<Rectangle>("sectionName", "keyName");

Rectangle rtValue =
    iniDoc.GetValue<Rectangle>("sectionName", "keyName", Rectangle.Empty);

iniDoc.SetValue("sectionName", "keyName", rtValue);

Helper functions:

//Helper Properties and Functions
TA_INIDocument iniDoc;
//Getting All Section Names
string[] sectionNames = iniDoc.SectionNames;
//Getting All Key Names of a Section
string[] keyNames = iniDoc.KeyNames("sectionName");
//Getting All Values of a Section
string[] allValues = iniDoc.SectionValues("sectionName");
//Check if section name exits
if (iniDoc.HasSection("sectionName"))
//Check if key name exits of specified section
if (iniDoc.HasKey("sectionName", "keyName"))

Saving all:

//Saving all data
TA_INIDocument iniDoc;
Stream iniStream;

iniDoc.Save(iniStream, Encoding.Unicode);
iniDoc.Save("C:\\sample.ini", Encoding.Unicode);


This article, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)

Written By
Software Developer (Senior)
Turkey Turkey
This member has not yet provided a Biography. Assume it's interesting and varied, and probably something to do with programming.

Comments and Discussions

GeneralTwo things not working Pin
Florin Pănescu13-Dec-18 2:33
MemberFlorin Pănescu13-Dec-18 2:33 
Questiongreat code !!! But.... Pin
ChristianGeiger13-Nov-13 2:03
MemberChristianGeiger13-Nov-13 2:03 
AnswerRe: great code !!! But.... Pin
Inlyrib3-Nov-15 2:27
MemberInlyrib3-Nov-15 2:27 
GeneralMy vote of 5 Pin
ChristianGeiger7-Nov-13 3:12
MemberChristianGeiger7-Nov-13 3:12 
BugCan not load a key that its value contain '=' Pin
Behzad Ebrahimi17-Apr-12 5:22
MemberBehzad Ebrahimi17-Apr-12 5:22 
GeneralMinor changes to get it work Pin
Member 46632441-Jun-09 22:13
MemberMember 46632441-Jun-09 22:13 
GeneralSection Name Casing Bug Pin
Paul E. Bible1-Dec-08 7:39
MemberPaul E. Bible1-Dec-08 7:39 
GeneralRe: Section Name Casing Bug Pin
Tolgahan ALBAYRAK1-Dec-08 10:56
MemberTolgahan ALBAYRAK1-Dec-08 10:56 
GeneralSuperb !!! Pin
Ashutosh Phoujdar12-Nov-08 19:37
MemberAshutosh Phoujdar12-Nov-08 19:37 
GeneralVery Nice Pin
Paul Conrad12-Nov-08 11:11
professionalPaul Conrad12-Nov-08 11:11 
GeneralRe: Very Nice Pin
Tolgahan ALBAYRAK12-Nov-08 22:44
MemberTolgahan ALBAYRAK12-Nov-08 22:44 
Generalcong.!! Pin
Caraxe10-Nov-08 12:04
MemberCaraxe10-Nov-08 12:04 
GeneralRe: cong.!! Pin
Tolgahan ALBAYRAK10-Nov-08 12:21
MemberTolgahan ALBAYRAK10-Nov-08 12:21 
GeneralTerminal Services and Performance Pin
Member 214447310-Nov-08 10:37
MemberMember 214447310-Nov-08 10:37 
GeneralRe: Terminal Services and Performance Pin
Tolgahan ALBAYRAK10-Nov-08 11:18
MemberTolgahan ALBAYRAK10-Nov-08 11:18 
QuestionPurpose? Pin
Denis Vuyka10-Nov-08 8:43
MemberDenis Vuyka10-Nov-08 8:43 
AnswerRe: Purpose? Pin
Tolgahan ALBAYRAK10-Nov-08 10:22
MemberTolgahan ALBAYRAK10-Nov-08 10:22 
GeneralRe: Purpose? Pin
Denis Vuyka10-Nov-08 21:06
MemberDenis Vuyka10-Nov-08 21:06 
GeneralRe: Purpose? Pin
Tolgahan ALBAYRAK10-Nov-08 21:56
MemberTolgahan ALBAYRAK10-Nov-08 21:56 
Generalregular expressions Pin
E. del Ayre9-Nov-08 20:31
MemberE. del Ayre9-Nov-08 20:31 
GeneralRe: regular expressions Pin
Tolgahan ALBAYRAK10-Nov-08 9:31
MemberTolgahan ALBAYRAK10-Nov-08 9:31 
QuestionPerformance comparison -- benchmark app? Pin
bolivar1237-Nov-08 4:00
Memberbolivar1237-Nov-08 4:00 
AnswerRe: Performance comparison -- benchmark app? Pin
Tolgahan ALBAYRAK7-Nov-08 6:54
MemberTolgahan ALBAYRAK7-Nov-08 6:54 
GeneralRe: Performance comparison -- benchmark app? Pin
#realJSOP8-Nov-08 1:52
mva#realJSOP8-Nov-08 1:52 
GeneralRe: Performance comparison -- benchmark app? Pin
Tolgahan ALBAYRAK8-Nov-08 2:47
MemberTolgahan ALBAYRAK8-Nov-08 2:47 

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.