Click here to Skip to main content
11,577,710 members (62,938 online)
Click here to Skip to main content

An INI file handling class using C#

, 14 Mar 2002 553.3K 13.6K 141
Rate this:
Please Sign up or sign in to vote.
A C# class that exposes the INI file handling functions from Kernal32.dll
<!-- Download Links --> <!-- Add the rest of your HTML here -->

Introduction

I created a C# class Ini which exposes 2 functions from KERNEL32.dll. These functions are: WritePrivateProfileString and GetPrivateProfileString

Namespaces you will need: System.Runtime.InteropServices and System.Text

The Class

using System;
using System.Runtime.InteropServices;
using System.Text;

namespace Ini
{
    /// <summary>
    /// Create a New INI file to store or load data
    /// </summary>
    public class IniFile
    {
        public string path;

        [DllImport("kernel32")]
        private static extern long WritePrivateProfileString(string section,
            string key,string val,string filePath);
        [DllImport("kernel32")]
        private static extern int GetPrivateProfileString(string section,
                 string key,string def, StringBuilder retVal,
            int size,string filePath);

        /// <summary>
        /// INIFile Constructor.
        /// </summary>
        /// <PARAM name="INIPath"></PARAM>
        public IniFile(string INIPath)
        {
            path = INIPath;
        }
        /// <summary>
        /// Write Data to the INI File
        /// </summary>
        /// <PARAM name="Section"></PARAM>
        /// Section name
        /// <PARAM name="Key"></PARAM>
        /// Key Name
        /// <PARAM name="Value"></PARAM>
        /// Value Name
        public void IniWriteValue(string Section,string Key,string Value)
        {
            WritePrivateProfileString(Section,Key,Value,this.path);
        }
        
        /// <summary>
        /// Read Data Value From the Ini File
        /// </summary>
        /// <PARAM name="Section"></PARAM>
        /// <PARAM name="Key"></PARAM>
        /// <PARAM name="Path"></PARAM>
        /// <returns></returns>
        public string IniReadValue(string Section,string Key)
        {
            StringBuilder temp = new StringBuilder(255);
            int i = GetPrivateProfileString(Section,Key,"",temp, 
                                            255, this.path);
            return temp.ToString();

        }
    }
}

Using the class

Steps to use the Ini class:

  1. In your project namespace definition add 
    using INI;
  2. Create a INIFile like this
    INIFile ini = new INIFile("C:\\test.ini");
  3. Use IniWriteValue to write a new value to a specific key in a section or use IniReadValue to read a value FROM a key in a specific Section.

That's all. It's very easy in C# to include API functions in your class(es).

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

BLaZiNiX
Web Developer
Canada Canada
No Biography provided

You may also be interested in...

Comments and Discussions

 
Questionmy vote i 5 of 5 Pin
TorbjornWave2-Oct-14 0:54
memberTorbjornWave2-Oct-14 0:54 
GeneralMy Vote of 5 Pin
Szymon Roslowski6-Aug-14 5:49
memberSzymon Roslowski6-Aug-14 5:49 
QuestionSimple and great class Pin
Member 1038226927-Apr-14 2:41
memberMember 1038226927-Apr-14 2:41 
SuggestionSuggestion Pin
Nathan Ferreira Dos Santos30-Jan-14 13:41
memberNathan Ferreira Dos Santos30-Jan-14 13:41 
GeneralMy vote of 5 Pin
Elena Futornyak14-Jun-13 1:16
memberElena Futornyak14-Jun-13 1:16 
Questionoverwriting Pin
Member 998609411-Jun-13 16:06
memberMember 998609411-Jun-13 16:06 
GeneralMy vote of 5 Pin
Amogh Natu27-May-13 4:52
professionalAmogh Natu27-May-13 4:52 
GeneralMy vote of 5 Pin
jai_magical16-Apr-13 11:40
memberjai_magical16-Apr-13 11:40 
GeneralMy vote of 5 Pin
Saravanan.rex5-Sep-12 4:00
memberSaravanan.rex5-Sep-12 4:00 
GeneralRe: My vote of 5 Pin
Headzup27-Sep-12 2:16
memberHeadzup27-Sep-12 2:16 
GeneralRe: My vote of 5 Pin
Saravanan.rex27-Sep-12 7:23
memberSaravanan.rex27-Sep-12 7:23 
QuestionFormClosing Pin
paphnuty27-Aug-12 21:38
memberpaphnuty27-Aug-12 21:38 
Questionmy vote of 5 Pin
velt_99124-Apr-12 21:09
membervelt_99124-Apr-12 21:09 
QuestionIf you want to support unicode, use this. Pin
chozekun12-Mar-12 21:11
memberchozekun12-Mar-12 21:11 
GeneralMy vote of 5 Pin
koiser13-Feb-12 3:51
memberkoiser13-Feb-12 3:51 
GeneralMy vote of 5 Pin
sanket_14@rediff.com1-Nov-11 20:40
membersanket_14@rediff.com1-Nov-11 20:40 
GeneralMy vote of 5 Pin
Ali Fakoor21-Oct-11 21:44
memberAli Fakoor21-Oct-11 21:44 
QuestionRead and write ini files in VB.Net Pin
Nasenbaaer5-Oct-11 3:46
memberNasenbaaer5-Oct-11 3:46 
My piece of code in VB.Net

 <Runtime.InteropServices.DllImport("kernel32.dll", CharSet:=Runtime.InteropServices.CharSet.Ansi, SetLastError:=True)> _
            Private Function WritePrivateProfileString(Section As String, Key As String, Value As String, FilePath As String) As Long
            End Function
 
            <Runtime.InteropServices.DllImport("kernel32.dll", CharSet:=Runtime.InteropServices.CharSet.Ansi, SetLastError:=True)> _
            Private Function GetPrivateProfileString(Section As String, Key As String, DefaultValue As String, Result As System.Text.StringBuilder, Size As Integer, FilePath As String) As Long
            End Function
 

            ''' <summary>
            ''' Modify or create an value in an ini file. 
            ''' </summary>
            ''' <param name="FilePath">Path of ini file for example: C\Mydirectory\file.ini</param>
            ''' <param name="Section">Keyword Parent</param>
            ''' <param name="Key">Keyword</param>
            ''' <param name="Value">Value to store</param>
            ''' <returns>True if successfully</returns>
            ''' <remarks>Timo Böhme, www.goldengel.ch, info@goldengel.ch, http://msdn.microsoft.com/en-us/library/windows/desktop/ms724353%28v=vs.85%29.aspx
            ''' IniFileModifyValue:
            ''' If the function successfully copies the string to the initialization file, the return value is nonzero.</remarks>
            Public Function IniFileModifyValue(ByVal FilePath As String, ByVal Section As String, ByVal Key As String, ByVal Value As String) As Boolean
                Dim ret As Long
                Try
                    ret = WritePrivateProfileString(Section, Key, Value, FilePath)
                    If ret = 0 Then Return False
                Catch ex As Exception
                    Return False
                End Try
                Return True
            End Function
 

            ''' <summary>
            ''' Read an existing value in an ini file. Returns the default value if file or key does not exist.
            ''' </summary>
            ''' <param name="FilePath">Path of ini file for example: C\Mydirectory\file.ini</param>
            ''' <param name="Section">Keyword Parent</param>
            ''' <param name="Key">Keyword</param>
            ''' <param name="DefaultValue">Value to store</param>
            ''' <returns>The value from ini file</returns>
            ''' <remarks>http://msdn.microsoft.com/en-us/library/windows/desktop/ms724353%28v=vs.85%29.aspx
            ''' GetPrivateProfileString 
            ''' The return value is the number of characters copied to the buffer, not including the terminating null character.</remarks>
            Public Function IniFileReadSingleValue(FilePath As String, Section As String, Key As String, DefaultValue As String) As String
                Dim ret As Long
                Dim res As String = DefaultValue
                Dim sb As New System.Text.StringBuilder(255)
                If IO.File.Exists(FilePath) = True Then
 

                    ret = GetPrivateProfileString(Section, Key, DefaultValue, sb, sb.Capacity, FilePath)
                    If ret > 0 Then
                        ret = Global.System.Math.Min(ret, sb.Capacity) 'important! because ret could be more than 255
                        ret = Global.System.Math.Min(ret, sb.Length) 'important! because buffer can be unused and less than 255
                        res = sb.ToString(0, ret)
                    End If
                End If
 
                Return res
            End Function

GeneralMy vote of 5 Pin
Nasenbaaer5-Oct-11 3:45
memberNasenbaaer5-Oct-11 3:45 
Questionhave 5 stars Pin
Shivamkalra22-Jun-11 18:57
memberShivamkalra22-Jun-11 18:57 
Question5 star Pin
Shivamkalra22-Jun-11 18:56
memberShivamkalra22-Jun-11 18:56 
RantOK Pin
mebaba12-May-11 23:06
membermebaba12-May-11 23:06 
GeneralMy vote of 5 Pin
Member 4458079 Jose5-May-11 15:35
memberMember 4458079 Jose5-May-11 15:35 
GeneralMy vote of 5 Pin
dv7617-Mar-11 22:20
memberdv7617-Mar-11 22:20 
Generalsuggestion to add some more methods to this class. Pin
hugoandrioli@yahoo.com28-Dec-10 0:15
memberhugoandrioli@yahoo.com28-Dec-10 0:15 

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
Web04 | 2.8.150603.1 | Last Updated 15 Mar 2002
Article Copyright 2002 by BLaZiNiX
Everything else Copyright © CodeProject, 1999-2015
Layout: fixed | fluid