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

How to read and write an INI File

, 17 Sep 2002
Rate this:
Please Sign up or sign in to vote.
List sections and section data (key-value pairs). Displays a key value and creates/modifies a key-value pair
<!-- Article image -->

Sample Image - INI.jpg

<!-- Add the rest of your HTML here -->

Introduction

CIniReader is a class that reads/writes from/to an INI file.

Details

Here are functions list of this class:

  • setINIFileName Sets the INI File name to read and write.
  • getKeyValue Used to retrieve a key value given the section and key name.
  • getSectionData Used to retrieve all key/value pairs of a given section.
  • getSectionNames Used to retrieve all the sections in an ini file
  • sectionExists Used to find out if a given section exists.
  • setKey Used to modify the key value or to create a key value pair for the specified section.

The functions in CIniReader use GetPrivateProfilexxx () functions to set, get information stored in an INI file. By having idea of the SDK functions like GetPrivateProfilexxx (), the functionality of the class can easily be extended.

Here is the CIniReader header file:

//
// CIniReader- Header File
//
class CIniReader  
{
public:
  // method to set INI file name, if not already specified 
  void setINIFileName(CString strINIFile);
  
  // methods to return the lists of section data and section names
  CStringList* getSectionData(CString strSection);
  CStringList* getSectionNames();
  
  // check if the section exists in the file
  BOOL sectionExists(CString strSection);

  // updates the key value, if key already exists, 
  // else creates a key-value pair
  long setKey(CString strValue, CString strKey, CString strSection);

  // give the key value for the specified key of a section
  CString getKeyValue(CString strKey,CString strSection);
  
  // default constructor
  CIniReader()
  {
    m_sectionList = new CStringList();
    m_sectionDataList = new CStringList();
  }
  
  CIniReader(CString strFile)
  {
    m_strFileName = strFile;
    m_sectionList = new CStringList();
    m_sectionDataList = new CStringList();
  }
  
  ~CIniReader()
  {
    delete m_sectionList;
    delete m_sectionDataList;
  }
  
private:
  // lists to keep sections and section data
  CStringList *m_sectionDataList;
  CStringList *m_sectionList;
  
  CString m_strSection;
  long m_lRetValue;
  
  // ini file name 
  CString m_strFileName;
};

How to use the class?

Demo project shows how to use the class. It takes from the user the fully qualified path and name of the INI file as C:\WINDOWS\ODBC.INI in the INI File name edit box. List Sections fills the list of sections in the INI file. Specifying any of the section names, and clicking the List Keys buttons will fill the second list box with the section data (all key and value pairs). Specifying a key name and pressing the Show Key Value button will display the value of the key. Update Key Value will update the modified value from the key value edit box for the key. If key not already present, update key value will create the specified key-value pair in the INI file. Be sure what you are doing, as it will modify the keys and values of INI.

Currently the buffer limit is up to 2000 characters, which can be increased according to the requirement.

After setting the INI file name just as the following code, you can proceed with using CIniReader functions:

// example of using the setINIFileName method
CIniReader  m_IniReader;
m_strINIFile = “C:\\WINDOWS\\ODBC.INI”;
m_IniReader.setINIFileName (m_strINIFile); 
That's it. The class is so simple and easy to use, I am sure you will have no problem.

    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

    Aisha Ikram
    Team Leader
    United Kingdom United Kingdom
    I am currently working as a Technical Lead in a software house in UK. I am Master in Science in Computer Science. I worked in .NET 1.1/2.0, C#, VB.NET, ASP.NET, VC++ 6, MFC, ATL, COM/DCOM, SQL Server 2000/2005. These days i am learning all .Net 3.x stuff. My free source code and articles website at http://aishai.netfirms.com

    Comments and Discussions

     
    GeneralMy vote of 4 PinmemberVEMS20-Nov-12 6:51 
    GeneralGetPrivateprofileString fails while reading the value against certain sections if it is huge data against it. Pinmemberdeeps19859-May-11 2:37 
    GeneralOptimization on enumeration functions :) PinmemberBehzad Ebrahimi6-Nov-10 3:46 
    GeneralKey Count in INI file PinmemberApril20048-Oct-10 18:52 
    AnswerRe: Key Count in INI file PinmemberBehzad Ebrahimi6-Nov-10 3:37 
    GeneralThanks PinmembervideoDev26-Aug-10 0:18 
    NewsTry this one too PinmemberGamePlanner20-Apr-09 11:16 
    GeneralRe: Try this one too PinmemberBehzad Ebrahimi6-Nov-10 3:50 
    GeneralINI file Pinmembersaiful_vonair14-Apr-09 16:01 
    QuestionIs it possible to give the relative path of the ini file? PinmemberNILANKARAJA4-Dec-06 17:09 
    AnswerRe: Is it possible to give the relative path of the ini file? Pinmembermr0x27-Feb-07 21:55 
    Generalthanks much Pinsussabalicaner21-Oct-05 20:59 
    GeneralGood work PinmemberAdnan Shaheen Yousaf Zai25-Sep-05 22:01 
    GeneralRe: Good work PinmemberEjaz15-Oct-05 2:04 
    GeneralRe: Good work PinmemberBehzad Ebrahimi6-Nov-10 3:40 
    GeneralRe: Good work PinmemberEjaz15-Nov-10 17:18 
    QuestionRemove a key? Pinmembermomo727-Jun-05 22:18 
    AnswerRe: Remove a key? PinmemberLee Sung Ho20-Mar-06 22:20 
    GeneralGood Article PinsussThiagarajan Rajendran4-Nov-04 19:02 
    GeneralError message from linker Pinsusswalter1234566-Apr-03 2:02 
    GeneralRe: Error message from linker PinmemberAisha Ikram6-Apr-03 20:27 
    GeneralYou can use my class in your C++/Win32/MFC code PinsussAisha Ikram16-Mar-03 22:17 
    GeneralRe: You can use my class in your C++/Win32/MFC code PinmemberKin Hoon17-Aug-03 7:40 
    GeneralRequest to Author PinsussTom diep22-Jan-03 15:56 
    GeneralRe: Request to Author PinsussAnonymous22-Jan-03 15: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 | Mobile
    Web02 | 2.8.141029.1 | Last Updated 18 Sep 2002
    Article Copyright 2002 by Aisha Ikram
    Everything else Copyright © CodeProject, 1999-2014
    Terms of Service
    Layout: fixed | fluid