<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <title>Class Poco::Util::IniFileConfiguration</title> <meta http-equiv="content-type" content="text/html; charset=utf-8"/> <meta name="author" content="Applied Informatics Software Engineering GmbH and Contributors"/> <meta name="publisher" content="Applied Informatics Software Engineering GmbH and Contributors"/> <meta name="copyright" content="Copyright (c) 2009, Applied Informatics Software Engineering GmbH and Contributors"/> <meta name="language" content="en"/> <meta name="date" content="2009-11-24"/> <meta name="generator" content="PocoDoc"/> <link rel="stylesheet" href="css/styles.css" type="text/css"/> </head> <body bgcolor="#ffffff" leftmargin="0" topmargin="0"> <div class="header"> <h1 class="namespace"><a href="Poco.Util.html" class="namespace">Poco::Util</a></h1> <h1 class="symbol">class IniFileConfiguration</h1> </div> <div class="body"> <p> <b>Library:</b> Util<br /> <b>Package:</b> Configuration<br /> <b>Header:</b> Poco/Util/IniFileConfiguration.h</p> <h2>Description</h2> <div class="description"> <p>This implementation of a Configuration reads properties from a legacy Windows initialization (.ini) file. </p> <p>The file syntax is implemented as follows. </p> <ul> <li>a line starting with a semicolon is treated as a comment and ignored </li> <li>a line starting with a square bracket denotes a section key [<key>] </li> <li>every other line denotes a property assignment in the form <value key> = <value> </li> </ul> <p>The name of a property is composed of the section key and the value key, separated by a period (<section key>.<value key>). </p> <p>Property names are not case sensitive. Leading and trailing whitespace is removed from both keys and values. </p> <p>Setting properties is not supported. An attempt to set a property results in a <a href="Poco.NotImplementedException.html" title="class Poco::NotImplementedException">NotImplementedException</a> being thrown. </p> </div> <h2>Inheritance</h2> <p><b>Direct Base Classes: </b><a href="Poco.Util.AbstractConfiguration.html" title="class Poco::Util::AbstractConfiguration">AbstractConfiguration</a></p> <p><b>All Base Classes: </b><a href="Poco.RefCountedObject.html" title="class Poco::RefCountedObject">Poco::RefCountedObject</a>, <a href="Poco.Util.AbstractConfiguration.html" title="class Poco::Util::AbstractConfiguration">AbstractConfiguration</a></p> <h2>Member Summary</h2> <p><b>Member Functions: </b><a href="Poco.Util.IniFileConfiguration.html#16652" title="Poco::Util::IniFileConfiguration::enumerate()">enumerate</a>, <a href="Poco.Util.IniFileConfiguration.html#16646" title="Poco::Util::IniFileConfiguration::getRaw()">getRaw</a>, <a href="Poco.Util.IniFileConfiguration.html#16642" title="Poco::Util::IniFileConfiguration::load()">load</a>, <a href="Poco.Util.IniFileConfiguration.html#16649" title="Poco::Util::IniFileConfiguration::setRaw()">setRaw</a></p> <p><b>Inherited Functions: </b><a href="Poco.Util.AbstractConfiguration.html#16368" title="Poco::Util::AbstractConfiguration::createView()">createView</a>, <a href="Poco.RefCountedObject.html#9659" title="Poco::RefCountedObject::duplicate()">duplicate</a>, <a href="Poco.Util.AbstractConfiguration.html#16380" title="Poco::Util::AbstractConfiguration::enumerate()">enumerate</a>, <a href="Poco.Util.AbstractConfiguration.html#16372" title="Poco::Util::AbstractConfiguration::expand()">expand</a>, <a href="Poco.Util.AbstractConfiguration.html#16346" title="Poco::Util::AbstractConfiguration::getBool()">getBool</a>, <a href="Poco.Util.AbstractConfiguration.html#16341" title="Poco::Util::AbstractConfiguration::getDouble()">getDouble</a>, <a href="Poco.Util.AbstractConfiguration.html#16338" title="Poco::Util::AbstractConfiguration::getInt()">getInt</a>, <a href="Poco.Util.AbstractConfiguration.html#16374" title="Poco::Util::AbstractConfiguration::getRaw()">getRaw</a>, <a href="Poco.Util.AbstractConfiguration.html#16331" title="Poco::Util::AbstractConfiguration::getRawString()">getRawString</a>, <a href="Poco.Util.AbstractConfiguration.html#16326" title="Poco::Util::AbstractConfiguration::getString()">getString</a>, <a href="Poco.Util.AbstractConfiguration.html#16324" title="Poco::Util::AbstractConfiguration::hasOption()">hasOption</a>, <a href="Poco.Util.AbstractConfiguration.html#16322" title="Poco::Util::AbstractConfiguration::hasProperty()">hasProperty</a>, <a href="Poco.Util.AbstractConfiguration.html#16363" title="Poco::Util::AbstractConfiguration::keys()">keys</a>, <a href="Poco.Util.AbstractConfiguration.html#16385" title="Poco::Util::AbstractConfiguration::parseBool()">parseBool</a>, <a href="Poco.Util.AbstractConfiguration.html#16383" title="Poco::Util::AbstractConfiguration::parseInt()">parseInt</a>, <a href="Poco.RefCountedObject.html#9661" title="Poco::RefCountedObject::referenceCount()">referenceCount</a>, <a href="Poco.RefCountedObject.html#9660" title="Poco::RefCountedObject::release()">release</a>, <a href="Poco.Util.AbstractConfiguration.html#16360" title="Poco::Util::AbstractConfiguration::setBool()">setBool</a>, <a href="Poco.Util.AbstractConfiguration.html#16357" title="Poco::Util::AbstractConfiguration::setDouble()">setDouble</a>, <a href="Poco.Util.AbstractConfiguration.html#16354" title="Poco::Util::AbstractConfiguration::setInt()">setInt</a>, <a href="Poco.Util.AbstractConfiguration.html#16377" title="Poco::Util::AbstractConfiguration::setRaw()">setRaw</a>, <a href="Poco.Util.AbstractConfiguration.html#16351" title="Poco::Util::AbstractConfiguration::setString()">setString</a></p> <h2>Constructors</h2> <h3><a name="16637">IniFileConfiguration</a></h3> <p class="decl"><a href="Poco.Util.IniFileConfiguration.html" title="class Poco::Util::IniFileConfiguration">IniFileConfiguration</a>();</p> <div class="description"> <p>Creates an empty <a href="Poco.Util.IniFileConfiguration.html" title="class Poco::Util::IniFileConfiguration">IniFileConfiguration</a>. </p> </div> <h3><a name="16638">IniFileConfiguration</a></h3> <p class="decl"><a href="Poco.Util.IniFileConfiguration.html" title="class Poco::Util::IniFileConfiguration">IniFileConfiguration</a>(<br /> std::istream & istr<br />);</p> <div class="description"> <p>Creates an <a href="Poco.Util.IniFileConfiguration.html" title="class Poco::Util::IniFileConfiguration">IniFileConfiguration</a> and loads the configuration data from the given stream, which must be in initialization file format. </p> </div> <h3><a name="16640">IniFileConfiguration</a></h3> <p class="decl"><a href="Poco.Util.IniFileConfiguration.html" title="class Poco::Util::IniFileConfiguration">IniFileConfiguration</a>(<br /> const std::string & path<br />);</p> <div class="description"> <p>Creates an <a href="Poco.Util.IniFileConfiguration.html" title="class Poco::Util::IniFileConfiguration">IniFileConfiguration</a> and loads the configuration data from the given file, which must be in initialization file format. </p> </div> <h2>Destructor</h2> <h3><a name="16655">~IniFileConfiguration</a> <img src="images/protected.gif" alt="protected" title="protected" style="vertical-align:baseline;" border="0" /> <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl">~<a href="Poco.Util.IniFileConfiguration.html" title="class Poco::Util::IniFileConfiguration">IniFileConfiguration</a>();</p> <div class="description"> <p></p> </div> <h2>Member Functions</h2> <h3><a name="16642">load</a></h3> <p class="decl">void load(<br /> std::istream & istr<br />);</p> <div class="description"> <p>Loads the configuration data from the given stream, which must be in initialization file format. </p> </div> <h3><a name="16644">load</a></h3> <p class="decl">void load(<br /> const std::string & path<br />);</p> <div class="description"> <p>Loads the configuration data from the given file, which must be in initialization file format. </p> </div> <h3><a name="16652">enumerate</a> <img src="images/protected.gif" alt="protected" title="protected" style="vertical-align:baseline;" border="0" /> <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl">void enumerate(<br /> const std::string & key,<br /> Keys & range<br />) const;</p> <div class="description"> <p></p> </div> <div class="description"><p><b>See also:</b> <a href="Poco.Util.AbstractConfiguration.html#16380" title="Poco::Util::AbstractConfiguration::enumerate()">Poco::Util::AbstractConfiguration::enumerate()</a></p></div> <h3><a name="16646">getRaw</a> <img src="images/protected.gif" alt="protected" title="protected" style="vertical-align:baseline;" border="0" /> <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl">bool getRaw(<br /> const std::string & key,<br /> std::string & value<br />) const;</p> <div class="description"> <p></p> </div> <div class="description"><p><b>See also:</b> <a href="Poco.Util.AbstractConfiguration.html#16374" title="Poco::Util::AbstractConfiguration::getRaw()">Poco::Util::AbstractConfiguration::getRaw()</a></p></div> <h3><a name="16649">setRaw</a> <img src="images/protected.gif" alt="protected" title="protected" style="vertical-align:baseline;" border="0" /> <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl">void setRaw(<br /> const std::string & key,<br /> const std::string & value<br />);</p> <div class="description"> <p></p> </div> <div class="description"><p><b>See also:</b> <a href="Poco.Util.AbstractConfiguration.html#16377" title="Poco::Util::AbstractConfiguration::setRaw()">Poco::Util::AbstractConfiguration::setRaw()</a></p></div> <p class="footer">POCO C++ Libraries 1.3.6-all<br /> Copyright © 2009, <a href="http://pocoproject.org/" target="_blank">Applied Informatics Software Engineering GmbH and Contributors</a></p> </div> </body> </html>
