Class IniFile

Index Home MAE > MAE Architecture > MAE Data Types > Class Index > Class IniFile

Using IniFile
File Format
Public Methods
IniFile(filename)
inline string getFilename() const
inline string getErrorMessage() const
inline string getComment() const
inline IniFile& setFilename(newFilename)
inline void clearErrorMessage()
inline void setComment(newComment)
bool read(filename, basefilename)
bool read(f, basefilename)
bool read(f, basefilename)
bool write(filename)
inline unsigned int getNoSections() const
inline StringSet getSections() const
inline bool valid()
inline void setSection(newSection)
inline const string& getSection() const
inline void setGlobal()
inline const string get(variable) const
inline const int getInt(variable) const
inline const float getFloat(variable)
inline const bool getBool(variable) const
inline const string operator[](variable)
inline const string getGlobal(variable) const
inline const int getGlobalInt(variable) const
inline const float getGlobalFloat(variable)
inline const bool getGlobalBool(variable) const
inline const vector getList() const
inline const string get(section, variable) const
inline const int getInt(section, variable) const
inline const float getFloat(section, variable)
inline const bool getBool(section, variable) const
inline const vector getList(section) const
inline void set(variable, value)
inline void set(variable, value)
inline void set(variable, value)
inline void setBool(variable, value)
inline void unset(variable)
void unset(section, variable)
void set(section, variable, value)
void set(section, variable, value)
void set(section, variable, value)
Private Properties
Private Methods
string readLine(f)
string getSection(line)
bool parseLine(inputLineNo, filenamebase, section, line)

#include <IniFile.h >

Super class: XMLData

Using IniFile

The IniFile class is used to read .ini files and provide methods to query values from its various sections.

The IniFile class reads a standard INI file format.

File Format

Syntax:

The first line of output is the headers:

AppName,Section,Variable,Value

where,

Header

Description

AppName

The name of the application for these properties.

Section

The section (grouping) of the application for these properties.

Variable

The keyword for the property.

Value

The value of the property.


Public Methods

IniFile(filename)

const string& filename

Default value: ""


inline string getFilename() const

inline string getErrorMessage() const

inline string getComment() const

inline IniFile& setFilename(newFilename)

const string& newFilename


inline void clearErrorMessage()

inline void setComment(newComment)

const string& newComment


bool read(filename, basefilename)

const string& filename

string basefilename

Default value: ""


Check getErrorMessage() to find out what went wrong

bool read(f, basefilename)

FILE* f

const string& basefilename

Default value: ""


bool read(f, basefilename)

TextFile& f

const string& basefilename

Default value: ""


bool write(filename)

const string& filename

Default value: ""


inline unsigned int getNoSections() const

inline StringSet getSections() const

inline bool valid()

inline void setSection(newSection)

const string& newSection

Default value: ""


inline const string& getSection() const

inline void setGlobal()

inline const string get(variable) const

const string& variable


Query an INI variable (after calling setSection() or setGlobal())

inline const int getInt(variable) const

const string& variable


inline const float getFloat(variable)

const string& variable


inline const bool getBool(variable) const

const string& variable


inline const string operator[](variable)

const string& variable


inline const string getGlobal(variable) const

const string& variable


Query an INI global variable

inline const int getGlobalInt(variable) const

const string& variable


inline const float getGlobalFloat(variable)

const string& variable


inline const bool getGlobalBool(variable) const

const string& variable


inline const vector <string > getList() const

Query list of all INI variable names (after calling setSection() or setGloal())

inline const string get(section, variable) const

const string& section

const string& variable


Query an INI variable using section

inline const int getInt(section, variable) const

const string& section

const string& variable


inline const float getFloat(section, variable)

const string& section

const string& variable


inline const bool getBool(section, variable) const

const string& section

const string& variable


inline const vector <string > getList(section) const

const string& section


Query list of all INI variables for a section

inline void set(variable, value)

const string& variable

const string& value


Set an INI variable's value (after calling setSection() or setGlobal()

inline void set(variable, value)

const string& variable

int value


inline void set(variable, value)

const string& variable

float value


inline void setBool(variable, value)

const string& variable

bool value


inline void unset(variable)

const string& variable


Unset an INI variable's value (after calling setSection() or setGlobal()

void unset(section, variable)

const string& section

const string& variable


void set(section, variable, value)

const string& section

const string& variable

const string& value


void set(section, variable, value)

const string& section

const string& variable

int value


void set(section, variable, value)

const string& section

const string& variable

float value


Private Properties

string inifilename

string line1

comment

string errmsg

string section


Private Methods

string readLine(f)

FILE* f


string getSection(line)

string line


bool parseLine(inputLineNo, filenamebase, section, line)

int inputLineNo

string filenamebase

string section

string line