.. index:: pair: class; EE::System::IniFile
.. _doxid-class_e_e_1_1_system_1_1_ini_file:

class EE::System::IniFile
=========================

.. toctree::
	:hidden:

	enum_EE_System_IniFile_errors.rst
	struct_EE_System_IniFile_key.rst
	struct_EE_System_IniFile_value.rst

Overview
~~~~~~~~




.. ref-code-block:: cpp
	:class: doxyrest-overview-code-block

	#include <inifile.hpp>
	
	class IniFile {
	public:
		// enums
	
		enum :ref:`errors<doxid-class_e_e_1_1_system_1_1_ini_file_1a6253ec08fc7dfc839aa2789395b7d31a>`;

		// structs
	
		struct :ref:`key<doxid-struct_e_e_1_1_system_1_1_ini_file_1_1key>`;
		struct :ref:`value<doxid-struct_e_e_1_1_system_1_1_ini_file_1_1value>`;

		// construction
	
		:ref:`IniFile<doxid-class_e_e_1_1_system_1_1_ini_file_1a5ea56622ea02d367d4b8a9bc00f19601>`(std::string_view iniPath = {}, bool autoLoad = true);
		:ref:`IniFile<doxid-class_e_e_1_1_system_1_1_ini_file_1af06b7fb04b43005e54446ddc757e6590>`(const :ref:`Uint8<doxid-namespace_e_e_1aa226754e64fe26f32b5526c7cd36fa75>`* RAWData, const :ref:`Uint32<doxid-namespace_e_e_1acb11e434631749f2da0e0004d6038558>`& size, bool autoLoad = true);
		:ref:`IniFile<doxid-class_e_e_1_1_system_1_1_ini_file_1a71aabdc6d7bef1934d92cbcb2dbccd62>`(:ref:`Pack<doxid-class_e_e_1_1_system_1_1_pack>`* Pack, std::string_view iniPackPath, bool autoLoad = true);
		:ref:`IniFile<doxid-class_e_e_1_1_system_1_1_ini_file_1ab1f73ad0e92573226652727b8c13d062>`(:ref:`IOStream<doxid-class_e_e_1_1_system_1_1_i_o_stream>`& stream, bool autoLoad = true);
		virtual :target:`~IniFile<doxid-class_e_e_1_1_system_1_1_ini_file_1a0092fa6133806efbfd6f7b66739aa2c9>`();

		// methods
	
		bool :ref:`loadFromFile<doxid-class_e_e_1_1_system_1_1_ini_file_1ab1f91e33b1bfd4310f0d0fbf2d002066>`(std::string_view iniPath);
		bool :ref:`loadFromMemory<doxid-class_e_e_1_1_system_1_1_ini_file_1aca151f664bdce91556bd3a04d86775be>`(const :ref:`Uint8<doxid-namespace_e_e_1aa226754e64fe26f32b5526c7cd36fa75>`* RAWData, const :ref:`Uint32<doxid-namespace_e_e_1acb11e434631749f2da0e0004d6038558>`& size);
		bool :ref:`loadFromPack<doxid-class_e_e_1_1_system_1_1_ini_file_1a0854865c6c43ea0dccd3f8a916d8b13f>`(:ref:`Pack<doxid-class_e_e_1_1_system_1_1_pack>`* Pack, std::string_view iniPackPath);
		bool :ref:`loadFromStream<doxid-class_e_e_1_1_system_1_1_ini_file_1a72164a9991a92b010656ebf8bcc88d86>`(:ref:`IOStream<doxid-class_e_e_1_1_system_1_1_i_o_stream>`& stream);
		void :ref:`path<doxid-class_e_e_1_1_system_1_1_ini_file_1ae54806660b51aef5210e363214e9d52f>`(std::string_view newPath);
		const std::string& :ref:`path<doxid-class_e_e_1_1_system_1_1_ini_file_1a823c6fc047cbd38c10d41dcb95d8f165>`() const;
		bool :ref:`readFile<doxid-class_e_e_1_1_system_1_1_ini_file_1a6a8d372562567b7a2cecdf38e9c9260a>`();
		bool :ref:`writeFile<doxid-class_e_e_1_1_system_1_1_ini_file_1a41877d4f3299d4986323abb15c25273f>`();
		bool :ref:`writeStream<doxid-class_e_e_1_1_system_1_1_ini_file_1a21b1d986eef7f78f5eb0b357c326a65e>`(:ref:`IOStream<doxid-class_e_e_1_1_system_1_1_i_o_stream>`& stream);
		void :ref:`clear<doxid-class_e_e_1_1_system_1_1_ini_file_1ae09a47ccdeec8325370ee471c7a6bd3e>`();
		long :ref:`findKey<doxid-class_e_e_1_1_system_1_1_ini_file_1a4b7b3b0a7db4029d9392d343371c7439>`(std::string_view keyname) const;
		long :ref:`findValue<doxid-class_e_e_1_1_system_1_1_ini_file_1a3ed528ee64cfbbc4ce046d21956c6aba>`(unsigned const keyID, std::string_view valuename) const;
		unsigned :ref:`getNumKeys<doxid-class_e_e_1_1_system_1_1_ini_file_1a6dcde4d66cdac0f2b5a2fc7b15759496>`() const;
		unsigned :ref:`addKeyName<doxid-class_e_e_1_1_system_1_1_ini_file_1adaf8b499c17dafe63dfe5dca3833af0c>`(std::string_view keyname);
		std::string :ref:`getKeyName<doxid-class_e_e_1_1_system_1_1_ini_file_1a732036f38bbc4e01d671d0a044209862>`(unsigned const keyID) const;
		unsigned :ref:`getNumValues<doxid-class_e_e_1_1_system_1_1_ini_file_1a911239851cd564b1aca69a72f2c7a6ca>`(unsigned const keyID);
		unsigned :ref:`getNumValues<doxid-class_e_e_1_1_system_1_1_ini_file_1a848e827e7e237325cb8e222b6004588d>`(std::string_view keyname);
		std::string :ref:`getValueName<doxid-class_e_e_1_1_system_1_1_ini_file_1aec7ae8f638e48c2c17405ce4c47ddbee>`(unsigned const keyID, unsigned const valueID) const;
		std::string :ref:`getValueName<doxid-class_e_e_1_1_system_1_1_ini_file_1a42e225c6ea7ca1f6595dfc53aba8a5c0>`(std::string_view keyname, unsigned const valueID) const;
		std::string :ref:`getValue<doxid-class_e_e_1_1_system_1_1_ini_file_1a8a78c2ec94ab6ff416c0e2697219a359>`(unsigned const keyID, unsigned const valueID, std::string_view defValue = {}) const;
		std::string :ref:`getValue<doxid-class_e_e_1_1_system_1_1_ini_file_1a86f63ec90b8bb5580ac7094aa39503c8>`(std::string_view keyname, std::string_view valuename, std::string_view defValue = {}) const;
		int :ref:`getValueI<doxid-class_e_e_1_1_system_1_1_ini_file_1afa03db46349dfd71f4e635b9348602be>`(std::string_view keyname, std::string_view valuename, int const defValue = 0) const;
		unsigned long :ref:`getValueU<doxid-class_e_e_1_1_system_1_1_ini_file_1aac9145797abbdcedfd7e08f574eae0ed>`(std::string_view keyname, std::string_view valuename, unsigned long const defValue = 0) const;
		bool :ref:`getValueB<doxid-class_e_e_1_1_system_1_1_ini_file_1aae9319ab0a05a4d7808a50743a8640ba>`(std::string_view keyname, std::string_view valuename, bool const defValue = false) const;
		double :ref:`getValueF<doxid-class_e_e_1_1_system_1_1_ini_file_1a280e73057c712a69cd8761a8099bebe1>`(std::string_view keyname, std::string_view valuename, double const defValue = 0.0) const;
		bool :ref:`setValue<doxid-class_e_e_1_1_system_1_1_ini_file_1a4df12b4917914b227c9a127ea4c68d3a>`(unsigned const keyID, unsigned const valueID, std::string_view value);
		bool :ref:`setValue<doxid-class_e_e_1_1_system_1_1_ini_file_1a92737ee85fee646724dd8346782f3658>`(std::string_view keyname, std::string_view valuename, std::string_view value, bool create = true);
		bool :ref:`setValueI<doxid-class_e_e_1_1_system_1_1_ini_file_1a6370158a4fc5328391c0f64b1a016440>`(std::string_view keyname, std::string_view valuename, int const value, bool create = true);
		bool :ref:`setValueU<doxid-class_e_e_1_1_system_1_1_ini_file_1abe4909ca5d5c5f99c48bcb86ced19034>`(std::string_view keyname, std::string_view valuename, unsigned long const value, bool create = true);
		bool :ref:`setValueB<doxid-class_e_e_1_1_system_1_1_ini_file_1aabe1a9c9e3a0b27195f1f0990cadd8ed>`(std::string_view keyname, std::string_view valuename, bool const value, bool create = true);
		bool :ref:`setValueF<doxid-class_e_e_1_1_system_1_1_ini_file_1ac436a8c194de4111ecc04174d759b252>`(std::string_view keyname, std::string_view valuename, double const value, bool create = true);
		bool :ref:`setValueV<doxid-class_e_e_1_1_system_1_1_ini_file_1a0de0e8a42d95d067409971e9734eed4e>`(std::string_view keyname, std::string_view valuename, char* format, ...);
		bool :ref:`deleteValue<doxid-class_e_e_1_1_system_1_1_ini_file_1a7b33445f34d3df866476b7fd83269e65>`(std::string_view keyname, std::string_view valuename);
		bool :ref:`deleteKey<doxid-class_e_e_1_1_system_1_1_ini_file_1a7f1fd4680a76e841374f591201641b17>`(std::string_view keyname);
		unsigned :ref:`numHeaderComments<doxid-class_e_e_1_1_system_1_1_ini_file_1aed4fd9e506a54046c6b6dd040afd9c9c>`();
		void :ref:`addHeaderComment<doxid-class_e_e_1_1_system_1_1_ini_file_1a059fd250ca9e9c5efd1539cc88cfa42a>`(std::string_view comment);
		std::string :ref:`getHeaderComment<doxid-class_e_e_1_1_system_1_1_ini_file_1a9f61064d9d8ecb8d4de20b4b1cee3fd4>`(unsigned const commentID) const;
		bool :ref:`deleteHeaderComment<doxid-class_e_e_1_1_system_1_1_ini_file_1ac7ad71c7c598c71452586ebe51f2138d>`(unsigned commentID);
		void :ref:`deleteHeaderComments<doxid-class_e_e_1_1_system_1_1_ini_file_1aaf2596216a718e8397d736a89815b01c>`();
		std::map<std::string, std::string> :target:`getKeyMap<doxid-class_e_e_1_1_system_1_1_ini_file_1a07111532222d8f930a1dd912755f9f7c>`(const unsigned& keyID) const;
		std::map<std::string, std::string> :target:`getKeyMap<doxid-class_e_e_1_1_system_1_1_ini_file_1ab4d416b26c4a121dec4d8dbc5cccf076>`(std::string_view keyname) const;
		std::unordered_map<std::string, std::string> :target:`getKeyUnorderedMap<doxid-class_e_e_1_1_system_1_1_ini_file_1a9174ceba87d85698d45c8745791b6451>`(const unsigned& keyID) const;
		std::unordered_map<std::string, std::string> :target:`getKeyUnorderedMap<doxid-class_e_e_1_1_system_1_1_ini_file_1a5c24c6ce88e2c63694a2a3906bc72d6f>`(std::string_view keyname) const;
		unsigned :ref:`getNumKeyComments<doxid-class_e_e_1_1_system_1_1_ini_file_1ad752e275015046ddd6003be3c5a727b1>`(unsigned const keyID) const;
		unsigned :target:`getNumKeyComments<doxid-class_e_e_1_1_system_1_1_ini_file_1a556ec8eb91e30e24618f1ae5f1ccaa4f>`(std::string_view keyname) const;
		bool :ref:`addKeyComment<doxid-class_e_e_1_1_system_1_1_ini_file_1a133ee688468000e797206b54abedfb93>`(unsigned const keyID, std::string_view comment);
		bool :target:`addKeyComment<doxid-class_e_e_1_1_system_1_1_ini_file_1ab1c12cb365dfe9ab1bf68c21fc489e7f>`(std::string_view keyname, std::string_view comment);
		std::string :ref:`getKeyComment<doxid-class_e_e_1_1_system_1_1_ini_file_1adde6645fe5865271e7868deeb8b81c2a>`(unsigned const keyID, unsigned const commentID) const;
		std::string :target:`getKeyComment<doxid-class_e_e_1_1_system_1_1_ini_file_1ad984d3a201a7b58ff696a5dec34399e3>`(std::string_view keyname, unsigned const commentID) const;
		bool :ref:`deleteKeyComment<doxid-class_e_e_1_1_system_1_1_ini_file_1a6959c392030f2eda1efdc3afe55f4019>`(unsigned const keyID, unsigned const commentID);
		bool :target:`deleteKeyComment<doxid-class_e_e_1_1_system_1_1_ini_file_1a7a0bf8f9ab06c6e609a825b348781490>`(std::string_view keyname, unsigned const commentID);
		bool :ref:`deleteKeyComments<doxid-class_e_e_1_1_system_1_1_ini_file_1a1f05e7d31342f05b6060ad8c5ca04798>`(unsigned const keyID);
		bool :target:`deleteKeyComments<doxid-class_e_e_1_1_system_1_1_ini_file_1a7d1d1c04071117afcbc18b1fee14b312>`(std::string_view keyname);
		bool :target:`iniParsed<doxid-class_e_e_1_1_system_1_1_ini_file_1a5c83d0239447e64baa16fad903e8d51b>`();
		bool :target:`keyExists<doxid-class_e_e_1_1_system_1_1_ini_file_1a1316175e6d2a9503732b7f29e8193df7>`(std::string_view keyname) const;
		bool :target:`keyValueExists<doxid-class_e_e_1_1_system_1_1_ini_file_1a293175a4516d66f2a0cd243883d5adbd>`(std::string_view keyname, std::string_view valuename) const;
	};
.. _details-class_e_e_1_1_system_1_1_ini_file:

Detailed Documentation
~~~~~~~~~~~~~~~~~~~~~~



Construction
------------

.. index:: pair: function; IniFile
.. _doxid-class_e_e_1_1_system_1_1_ini_file_1a5ea56622ea02d367d4b8a9bc00f19601:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	IniFile(std::string_view iniPath = {}, bool autoLoad = true)

Initialize and load the ini file from path

.. index:: pair: function; IniFile
.. _doxid-class_e_e_1_1_system_1_1_ini_file_1af06b7fb04b43005e54446ddc757e6590:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	IniFile(const :ref:`Uint8<doxid-namespace_e_e_1aa226754e64fe26f32b5526c7cd36fa75>`* RAWData, const :ref:`Uint32<doxid-namespace_e_e_1acb11e434631749f2da0e0004d6038558>`& size, bool autoLoad = true)

Initialize and load the ini file from memory

.. index:: pair: function; IniFile
.. _doxid-class_e_e_1_1_system_1_1_ini_file_1a71aabdc6d7bef1934d92cbcb2dbccd62:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	IniFile(:ref:`Pack<doxid-class_e_e_1_1_system_1_1_pack>`* Pack, std::string_view iniPackPath, bool autoLoad = true)

Initialize and load the ini file from a pack file

.. index:: pair: function; IniFile
.. _doxid-class_e_e_1_1_system_1_1_ini_file_1ab1f73ad0e92573226652727b8c13d062:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	IniFile(:ref:`IOStream<doxid-class_e_e_1_1_system_1_1_i_o_stream>`& stream, bool autoLoad = true)

Initialize and load the ini file from a stream

Methods
-------

.. index:: pair: function; loadFromFile
.. _doxid-class_e_e_1_1_system_1_1_ini_file_1ab1f91e33b1bfd4310f0d0fbf2d002066:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	bool loadFromFile(std::string_view iniPath)

Loads an ini file from path

.. index:: pair: function; loadFromMemory
.. _doxid-class_e_e_1_1_system_1_1_ini_file_1aca151f664bdce91556bd3a04d86775be:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	bool loadFromMemory(const :ref:`Uint8<doxid-namespace_e_e_1aa226754e64fe26f32b5526c7cd36fa75>`* RAWData, const :ref:`Uint32<doxid-namespace_e_e_1acb11e434631749f2da0e0004d6038558>`& size)

Loads an ini file from memory

.. index:: pair: function; loadFromPack
.. _doxid-class_e_e_1_1_system_1_1_ini_file_1a0854865c6c43ea0dccd3f8a916d8b13f:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	bool loadFromPack(:ref:`Pack<doxid-class_e_e_1_1_system_1_1_pack>`* Pack, std::string_view iniPackPath)

Loads an ini file from a pack file

.. index:: pair: function; loadFromStream
.. _doxid-class_e_e_1_1_system_1_1_ini_file_1a72164a9991a92b010656ebf8bcc88d86:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	bool loadFromStream(:ref:`IOStream<doxid-class_e_e_1_1_system_1_1_i_o_stream>`& stream)

Loads an ini file from a stream

.. index:: pair: function; path
.. _doxid-class_e_e_1_1_system_1_1_ini_file_1ae54806660b51aef5210e363214e9d52f:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	void path(std::string_view newPath)

Sets mPath of ini file to read and write from.

.. index:: pair: function; path
.. _doxid-class_e_e_1_1_system_1_1_ini_file_1a823c6fc047cbd38c10d41dcb95d8f165:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	const std::string& path() const



.. rubric:: Returns:

The ini file path

.. index:: pair: function; readFile
.. _doxid-class_e_e_1_1_system_1_1_ini_file_1a6a8d372562567b7a2cecdf38e9c9260a:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	bool readFile()

Reads ini file specified using mPath.



.. rubric:: Returns:

true if successful, false otherwise.

.. index:: pair: function; writeFile
.. _doxid-class_e_e_1_1_system_1_1_ini_file_1a41877d4f3299d4986323abb15c25273f:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	bool writeFile()

Writes data stored in class to ini file.

.. index:: pair: function; writeStream
.. _doxid-class_e_e_1_1_system_1_1_ini_file_1a21b1d986eef7f78f5eb0b357c326a65e:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	bool writeStream(:ref:`IOStream<doxid-class_e_e_1_1_system_1_1_i_o_stream>`& stream)

Writes data stored in class to a :ref:`IOStream <doxid-class_e_e_1_1_system_1_1_i_o_stream>`.

.. index:: pair: function; clear
.. _doxid-class_e_e_1_1_system_1_1_ini_file_1ae09a47ccdeec8325370ee471c7a6bd3e:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	void clear()

Deletes all stored ini data.

.. index:: pair: function; findKey
.. _doxid-class_e_e_1_1_system_1_1_ini_file_1a4b7b3b0a7db4029d9392d343371c7439:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	long findKey(std::string_view keyname) const



.. rubric:: Returns:

index of specified key, or noID if not found.

.. index:: pair: function; findValue
.. _doxid-class_e_e_1_1_system_1_1_ini_file_1a3ed528ee64cfbbc4ce046d21956c6aba:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	long findValue(unsigned const keyID, std::string_view valuename) const



.. rubric:: Returns:

index of specified value, in the specified key, or noID if not found.

.. index:: pair: function; getNumKeys
.. _doxid-class_e_e_1_1_system_1_1_ini_file_1a6dcde4d66cdac0f2b5a2fc7b15759496:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	unsigned getNumKeys() const



.. rubric:: Returns:

number of Keys currently in the ini.

.. index:: pair: function; addKeyName
.. _doxid-class_e_e_1_1_system_1_1_ini_file_1adaf8b499c17dafe63dfe5dca3833af0c:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	unsigned addKeyName(std::string_view keyname)

Add a key name.

.. index:: pair: function; getKeyName
.. _doxid-class_e_e_1_1_system_1_1_ini_file_1a732036f38bbc4e01d671d0a044209862:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	std::string getKeyName(unsigned const keyID) const



.. rubric:: Returns:

key Names by index.

.. index:: pair: function; getNumValues
.. _doxid-class_e_e_1_1_system_1_1_ini_file_1a911239851cd564b1aca69a72f2c7a6ca:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	unsigned getNumValues(unsigned const keyID)



.. rubric:: Returns:

number of values stored for specified key.

.. index:: pair: function; getNumValues
.. _doxid-class_e_e_1_1_system_1_1_ini_file_1a848e827e7e237325cb8e222b6004588d:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	unsigned getNumValues(std::string_view keyname)



.. rubric:: Returns:

number of values stored for specified key from its name.

.. index:: pair: function; getValueName
.. _doxid-class_e_e_1_1_system_1_1_ini_file_1aec7ae8f638e48c2c17405ce4c47ddbee:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	std::string getValueName(unsigned const keyID, unsigned const valueID) const



.. rubric:: Returns:

value name by index for a given keyname or keyID.

.. index:: pair: function; getValueName
.. _doxid-class_e_e_1_1_system_1_1_ini_file_1a42e225c6ea7ca1f6595dfc53aba8a5c0:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	std::string getValueName(std::string_view keyname, unsigned const valueID) const



.. rubric:: Returns:

A value name from keyname and valueId

.. index:: pair: function; getValue
.. _doxid-class_e_e_1_1_system_1_1_ini_file_1a8a78c2ec94ab6ff416c0e2697219a359:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	std::string getValue(unsigned const keyID, unsigned const valueID, std::string_view defValue = {}) const

Gets value of [keyname] valuename =. :ref:`Overloaded <doxid-struct_e_e_1_1_overloaded>` to return std::string, int, and double.



.. rubric:: Returns:

defValue if key/value not found otherwise the value obtained.

.. index:: pair: function; getValue
.. _doxid-class_e_e_1_1_system_1_1_ini_file_1a86f63ec90b8bb5580ac7094aa39503c8:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	std::string getValue(std::string_view keyname, std::string_view valuename, std::string_view defValue = {}) const

Gets a value from a keyname and valuename

.. index:: pair: function; getValueI
.. _doxid-class_e_e_1_1_system_1_1_ini_file_1afa03db46349dfd71f4e635b9348602be:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	int getValueI(std::string_view keyname, std::string_view valuename, int const defValue = 0) const

Gets the value as integer

.. index:: pair: function; getValueU
.. _doxid-class_e_e_1_1_system_1_1_ini_file_1aac9145797abbdcedfd7e08f574eae0ed:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	unsigned long getValueU(std::string_view keyname, std::string_view valuename, unsigned long const defValue = 0) const

Gets the value as an unsigned long

.. index:: pair: function; getValueB
.. _doxid-class_e_e_1_1_system_1_1_ini_file_1aae9319ab0a05a4d7808a50743a8640ba:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	bool getValueB(std::string_view keyname, std::string_view valuename, bool const defValue = false) const

Gets the value as boolean

.. index:: pair: function; getValueF
.. _doxid-class_e_e_1_1_system_1_1_ini_file_1a280e73057c712a69cd8761a8099bebe1:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	double getValueF(std::string_view keyname, std::string_view valuename, double const defValue = 0.0) const

Gets the value as double

.. index:: pair: function; setValue
.. _doxid-class_e_e_1_1_system_1_1_ini_file_1a4df12b4917914b227c9a127ea4c68d3a:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	bool setValue(unsigned const keyID, unsigned const valueID, std::string_view value)

Sets value of [keyname] valuename =. Specify the optional parameter as false (0) if you do not want it to create the key if it doesn't exist.



.. rubric:: Returns:

true if data entered, false otherwise. :ref:`Overloaded <doxid-struct_e_e_1_1_overloaded>` to accept std::string, int, and double.

.. index:: pair: function; setValue
.. _doxid-class_e_e_1_1_system_1_1_ini_file_1a92737ee85fee646724dd8346782f3658:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	bool setValue(std::string_view keyname, std::string_view valuename, std::string_view value, bool create = true)

Sets the value from a keyname and a valuename



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- keyname

		- The key name

	*
		- valuename

		- The value name

	*
		- value

		- The value to assign

	*
		- create

		- If true it will create the keyname if doesn't exists

.. index:: pair: function; setValueI
.. _doxid-class_e_e_1_1_system_1_1_ini_file_1a6370158a4fc5328391c0f64b1a016440:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	bool setValueI(std::string_view keyname, std::string_view valuename, int const value, bool create = true)

Sets a integer value from a keyname and a valuename



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- keyname

		- The key name

	*
		- valuename

		- The value name

	*
		- value

		- The value to assign

	*
		- create

		- If true it will create the keyname if doesn't exists

.. index:: pair: function; setValueU
.. _doxid-class_e_e_1_1_system_1_1_ini_file_1abe4909ca5d5c5f99c48bcb86ced19034:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	bool setValueU(std::string_view keyname, std::string_view valuename, unsigned long const value, bool create = true)

Sets a unsigned long value from a keyname and a valuename



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- keyname

		- The key name

	*
		- valuename

		- The value name

	*
		- value

		- The value to assign

	*
		- create

		- If true it will create the keyname if doesn't exists

.. index:: pair: function; setValueB
.. _doxid-class_e_e_1_1_system_1_1_ini_file_1aabe1a9c9e3a0b27195f1f0990cadd8ed:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	bool setValueB(std::string_view keyname, std::string_view valuename, bool const value, bool create = true)

Sets a boolean value from a keyname and a valuename



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- keyname

		- The key name

	*
		- valuename

		- The value name

	*
		- value

		- The value to assign

	*
		- create

		- If true it will create the keyname if doesn't exists

.. index:: pair: function; setValueF
.. _doxid-class_e_e_1_1_system_1_1_ini_file_1ac436a8c194de4111ecc04174d759b252:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	bool setValueF(std::string_view keyname, std::string_view valuename, double const value, bool create = true)

Sets a double value from a keyname and a valuename



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- keyname

		- The key name

	*
		- valuename

		- The value name

	*
		- value

		- The value to assign

	*
		- create

		- If true it will create the keyname if doesn't exists

.. index:: pair: function; setValueV
.. _doxid-class_e_e_1_1_system_1_1_ini_file_1a0de0e8a42d95d067409971e9734eed4e:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	bool setValueV(std::string_view keyname, std::string_view valuename, char* format, ...)

Sets a formatted value from a keyname and a valuename

.. index:: pair: function; deleteValue
.. _doxid-class_e_e_1_1_system_1_1_ini_file_1a7b33445f34d3df866476b7fd83269e65:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	bool deleteValue(std::string_view keyname, std::string_view valuename)

Deletes specified value.



.. rubric:: Returns:

true if value existed and deleted, false otherwise.

.. index:: pair: function; deleteKey
.. _doxid-class_e_e_1_1_system_1_1_ini_file_1a7f1fd4680a76e841374f591201641b17:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	bool deleteKey(std::string_view keyname)

Deletes specified key and all values contained within.



.. rubric:: Returns:

true if key existed and deleted, false otherwise.

.. index:: pair: function; numHeaderComments
.. _doxid-class_e_e_1_1_system_1_1_ini_file_1aed4fd9e506a54046c6b6dd040afd9c9c:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	unsigned numHeaderComments()

Header comment functions. Header comments are those comments before the first key. Number of header comments.

.. index:: pair: function; addHeaderComment
.. _doxid-class_e_e_1_1_system_1_1_ini_file_1a059fd250ca9e9c5efd1539cc88cfa42a:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	void addHeaderComment(std::string_view comment)

Add a header comment.

.. index:: pair: function; getHeaderComment
.. _doxid-class_e_e_1_1_system_1_1_ini_file_1a9f61064d9d8ecb8d4de20b4b1cee3fd4:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	std::string getHeaderComment(unsigned const commentID) const

Return a header comment.

.. index:: pair: function; deleteHeaderComment
.. _doxid-class_e_e_1_1_system_1_1_ini_file_1ac7ad71c7c598c71452586ebe51f2138d:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	bool deleteHeaderComment(unsigned commentID)

Delete a header comment.

.. index:: pair: function; deleteHeaderComments
.. _doxid-class_e_e_1_1_system_1_1_ini_file_1aaf2596216a718e8397d736a89815b01c:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	void deleteHeaderComments()

Delete all header comments.

.. index:: pair: function; getNumKeyComments
.. _doxid-class_e_e_1_1_system_1_1_ini_file_1ad752e275015046ddd6003be3c5a727b1:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	unsigned getNumKeyComments(unsigned const keyID) const

Key comment functions. Key comments are those comments within a key. Any comments defined within value Names will be added to this list. Therefore, these comments will be moved to the top of the key definition when the :ref:`IniFile::writeFile() <doxid-class_e_e_1_1_system_1_1_ini_file_1a41877d4f3299d4986323abb15c25273f>` is called. Number of key comments.

.. index:: pair: function; addKeyComment
.. _doxid-class_e_e_1_1_system_1_1_ini_file_1a133ee688468000e797206b54abedfb93:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	bool addKeyComment(unsigned const keyID, std::string_view comment)

Add a key comment.

.. index:: pair: function; getKeyComment
.. _doxid-class_e_e_1_1_system_1_1_ini_file_1adde6645fe5865271e7868deeb8b81c2a:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	std::string getKeyComment(unsigned const keyID, unsigned const commentID) const

Return a key comment.

.. index:: pair: function; deleteKeyComment
.. _doxid-class_e_e_1_1_system_1_1_ini_file_1a6959c392030f2eda1efdc3afe55f4019:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	bool deleteKeyComment(unsigned const keyID, unsigned const commentID)

Delete a key comment.

.. index:: pair: function; deleteKeyComments
.. _doxid-class_e_e_1_1_system_1_1_ini_file_1a1f05e7d31342f05b6060ad8c5ca04798:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	bool deleteKeyComments(unsigned const keyID)

Delete all comments for a key.