#include <SimpleIni.h>

Classes
class	Converter

struct	Entry

class	FileWriter

class	OutputWriter

class	StringWriter

Public Types
typedef SI_CHAR	SI_CHAR_T

typedef std::multimap< Entry, const SI_CHAR *, typename Entry::KeyOrder >	TKeyVal

typedef std::map< Entry, TKeyVal, typename Entry::KeyOrder >	TSection

typedef std::list< Entry >	TNamesDepend

Public Member Functions
	CSimpleIniTempl (bool a_bIsUtf8=false, bool a_bMultiKey=false, bool a_bMultiLine=false)

	~CSimpleIniTempl ()

void	Reset ()

bool	IsEmpty () const

SI_Error	LoadFile (const char *a_pszFile)

SI_Error	LoadFile (FILE *a_fpFile)

SI_Error	LoadData (const std::string &a_strData)

SI_Error	LoadData (const char *a_pData, size_t a_uDataLen)

SI_Error	SaveFile (const char *a_pszFile, bool a_bAddSignature=true) const

SI_Error	SaveFile (FILE *a_pFile, bool a_bAddSignature=false) const

SI_Error	Save (OutputWriter &a_oOutput, bool a_bAddSignature=false) const

SI_Error	Save (std::string &a_sBuffer, bool a_bAddSignature=false) const

void	GetAllSections (TNamesDepend &a_names) const

bool	GetAllKeys (const SI_CHAR *a_pSection, TNamesDepend &a_names) const

bool	GetAllValues (const SI_CHAR a_pSection, const SI_CHAR a_pKey, TNamesDepend &a_values) const

int	GetSectionSize (const SI_CHAR *a_pSection) const

const TKeyVal *	GetSection (const SI_CHAR *a_pSection) const

bool	SectionExists (const SI_CHAR *a_pSection) const

bool	KeyExists (const SI_CHAR a_pSection, const SI_CHAR a_pKey) const

const SI_CHAR *	GetValue (const SI_CHAR a_pSection, const SI_CHAR a_pKey, const SI_CHAR a_pDefault=NULL, bool a_pHasMultiple=NULL) const

long	GetLongValue (const SI_CHAR a_pSection, const SI_CHAR a_pKey, long a_nDefault=0, bool *a_pHasMultiple=NULL) const

double	GetDoubleValue (const SI_CHAR a_pSection, const SI_CHAR a_pKey, double a_nDefault=0, bool *a_pHasMultiple=NULL) const

bool	GetBoolValue (const SI_CHAR a_pSection, const SI_CHAR a_pKey, bool a_bDefault=false, bool *a_pHasMultiple=NULL) const

SI_Error	SetValue (const SI_CHAR a_pSection, const SI_CHAR a_pKey, const SI_CHAR a_pValue, const SI_CHAR a_pComment=NULL, bool a_bForceReplace=false)

SI_Error	SetLongValue (const SI_CHAR a_pSection, const SI_CHAR a_pKey, long a_nValue, const SI_CHAR *a_pComment=NULL, bool a_bUseHex=false, bool a_bForceReplace=false)

SI_Error	SetDoubleValue (const SI_CHAR a_pSection, const SI_CHAR a_pKey, double a_nValue, const SI_CHAR *a_pComment=NULL, bool a_bForceReplace=false)

SI_Error	SetBoolValue (const SI_CHAR a_pSection, const SI_CHAR a_pKey, bool a_bValue, const SI_CHAR *a_pComment=NULL, bool a_bForceReplace=false)

bool	Delete (const SI_CHAR a_pSection, const SI_CHAR a_pKey, bool a_bRemoveEmpty=false)

bool	DeleteValue (const SI_CHAR a_pSection, const SI_CHAR a_pKey, const SI_CHAR *a_pValue, bool a_bRemoveEmpty=false)

Converter	GetConverter () const

Settings
void	SetUnicode (bool a_bIsUtf8=true)

bool	IsUnicode () const

void	SetMultiKey (bool a_bAllowMultiKey=true)

bool	IsMultiKey () const

void	SetMultiLine (bool a_bAllowMultiLine=true)

bool	IsMultiLine () const

void	SetSpaces (bool a_bSpaces=true)

bool	UsingSpaces () const

void	SetQuotes (bool a_bParseQuotes=true)

bool	UsingQuotes () const

void	SetAllowKeyOnly (bool a_bAllowKeyOnly=true)

bool	GetAllowKeyOnly () const

Detailed Description

template<class SI_CHAR, class SI_STRLESS, class SI_CONVERTER>
class CSimpleIniTempl< SI_CHAR, SI_STRLESS, SI_CONVERTER >

Simple INI file reader.

This can be instantiated with the choice of unicode or native characterset, and case sensitive or insensitive comparisons of section and key names. The supported combinations are pre-defined with the following typedefs:

Interface	Case-sensitive	Typedef
char	No	CSimpleIniA
char	Yes	CSimpleIniCaseA
wchar_t	No	CSimpleIniW
wchar_t	Yes	CSimpleIniCaseW

Note that using other types for the SI_CHAR is supported. For instance, unsigned char, unsigned short, etc. Note that where the alternative type is a different size to char/wchar_t you may need to supply new helper classes for SI_STRLESS and SI_CONVERTER.

Member Typedef Documentation

◆ TKeyVal

template<class SI_CHAR , class SI_STRLESS , class SI_CONVERTER >

typedef std::multimap<Entry,const SI_CHAR *,typename Entry::KeyOrder> CSimpleIniTempl< SI_CHAR, SI_STRLESS, SI_CONVERTER >::TKeyVal

map keys to values

◆ TNamesDepend

template<class SI_CHAR , class SI_STRLESS , class SI_CONVERTER >

typedef std::list<Entry> CSimpleIniTempl< SI_CHAR, SI_STRLESS, SI_CONVERTER >::TNamesDepend

set of dependent string pointers. Note that these pointers are dependent on memory owned by CSimpleIni.

◆ TSection

template<class SI_CHAR , class SI_STRLESS , class SI_CONVERTER >

typedef std::map<Entry,TKeyVal,typename Entry::KeyOrder> CSimpleIniTempl< SI_CHAR, SI_STRLESS, SI_CONVERTER >::TSection

map sections to key/value map

Constructor & Destructor Documentation

◆ CSimpleIniTempl()

template<class SI_CHAR , class SI_STRLESS , class SI_CONVERTER >

CSimpleIniTempl< SI_CHAR, SI_STRLESS, SI_CONVERTER >::CSimpleIniTempl	(	bool	a_bIsUtf8 = `false`,
		bool	a_bMultiKey = `false`,
		bool	a_bMultiLine = `false`
	)

Default constructor.

Parameters

a_bIsUtf8	See the method SetUnicode() for details.
a_bMultiKey	See the method SetMultiKey() for details.
a_bMultiLine	See the method SetMultiLine() for details.

◆ ~CSimpleIniTempl()

template<class SI_CHAR , class SI_STRLESS , class SI_CONVERTER >

CSimpleIniTempl< SI_CHAR, SI_STRLESS, SI_CONVERTER >::~CSimpleIniTempl

Destructor

Member Function Documentation

◆ Delete()

template<class SI_CHAR , class SI_STRLESS , class SI_CONVERTER >

bool CSimpleIniTempl< SI_CHAR, SI_STRLESS, SI_CONVERTER >::Delete	(	const SI_CHAR *	a_pSection,
		const SI_CHAR *	a_pKey,
		bool	a_bRemoveEmpty = `false`
	)

Delete an entire section, or a key from a section. Note that the data returned by GetSection is invalid and must not be used after anything has been deleted from that section using this method. Note when multiple keys is enabled, this will delete all keys with that name; to selectively delete individual key/values, use DeleteValue.

Parameters

a_pSection	Section to delete key from, or if a_pKey is NULL, the section to remove.
a_pKey	Key to remove from the section. Set to NULL to remove the entire section.
a_bRemoveEmpty	If the section is empty after this key has been deleted, should the empty section be removed?

Returns: true Key or section was deleted.; false Key or section was not found.

◆ DeleteValue()

template<class SI_CHAR , class SI_STRLESS , class SI_CONVERTER >

bool CSimpleIniTempl< SI_CHAR, SI_STRLESS, SI_CONVERTER >::DeleteValue	(	const SI_CHAR *	a_pSection,
		const SI_CHAR *	a_pKey,
		const SI_CHAR *	a_pValue,
		bool	a_bRemoveEmpty = `false`
	)

Delete an entire section, or a key from a section. If value is provided, only remove keys with the value. Note that the data returned by GetSection is invalid and must not be used after anything has been deleted from that section using this method. Note when multiple keys is enabled, all keys with the value will be deleted.

Parameters

a_pSection	Section to delete key from, or if a_pKey is NULL, the section to remove.
a_pKey	Key to remove from the section. Set to NULL to remove the entire section.
a_pValue	Value of key to remove from the section. Set to NULL to remove all keys.
a_bRemoveEmpty	If the section is empty after this key has been deleted, should the empty section be removed?

Returns: true Key/value or section was deleted.; false Key/value or section was not found.

◆ GetAllKeys()

template<class SI_CHAR , class SI_STRLESS , class SI_CONVERTER >

bool CSimpleIniTempl< SI_CHAR, SI_STRLESS, SI_CONVERTER >::GetAllKeys	(	const SI_CHAR *	a_pSection,
		TNamesDepend &	a_names
	)		const

Retrieve all unique key names in a section. The sort order of the returned strings is NOT DEFINED. You can sort the names into the load order if desired. Search this file for ".sort" for an example. Only unique key names are returned.

NOTE! This structure contains only pointers to strings. The actual string data is stored in memory owned by CSimpleIni. Ensure that the CSimpleIni object is not destroyed or Reset() while these strings are in use!

Parameters

a_pSection	Section to request data for
a_names	List that will receive all of the key names. See note above!

Returns: true Section was found.; false Matching section was not found.

◆ GetAllowKeyOnly()

template<class SI_CHAR , class SI_STRLESS , class SI_CONVERTER >

bool CSimpleIniTempl< SI_CHAR, SI_STRLESS, SI_CONVERTER >::GetAllowKeyOnly ( ) const

inline

Do we allow keys to exist without a value or equals sign?

◆ GetAllSections()

template<class SI_CHAR , class SI_STRLESS , class SI_CONVERTER >

void CSimpleIniTempl< SI_CHAR, SI_STRLESS, SI_CONVERTER >::GetAllSections ( TNamesDepend & a_names ) const

Retrieve all section names. The list is returned as an STL vector of names and can be iterated or searched as necessary. Note that the sort order of the returned strings is NOT DEFINED. You can sort the names into the load order if desired. Search this file for ".sort" for an example.

NOTE! This structure contains only pointers to strings. The actual string data is stored in memory owned by CSimpleIni. Ensure that the CSimpleIni object is not destroyed or Reset() while these pointers are in use!

Parameters

a_names Vector that will receive all of the section names. See note above!

◆ GetAllValues()

template<class SI_CHAR , class SI_STRLESS , class SI_CONVERTER >

bool CSimpleIniTempl< SI_CHAR, SI_STRLESS, SI_CONVERTER >::GetAllValues	(	const SI_CHAR *	a_pSection,
		const SI_CHAR *	a_pKey,
		TNamesDepend &	a_values
	)		const

Retrieve all values for a specific key. This method can be used when multiple keys are both enabled and disabled. Note that the sort order of the returned strings is NOT DEFINED. You can sort the names into the load order if desired. Search this file for ".sort" for an example.

NOTE! The returned values are pointers to string data stored in memory owned by CSimpleIni. Ensure that the CSimpleIni object is not destroyed or Reset while you are using this pointer!

Parameters

a_pSection	Section to search
a_pKey	Key to search for
a_values	List to return if the key is not found

Returns: true Key was found.; false Matching section/key was not found.

◆ GetBoolValue()

template<class SI_CHAR , class SI_STRLESS , class SI_CONVERTER >

bool CSimpleIniTempl< SI_CHAR, SI_STRLESS, SI_CONVERTER >::GetBoolValue	(	const SI_CHAR *	a_pSection,
		const SI_CHAR *	a_pKey,
		bool	a_bDefault = `false`,
		bool *	a_pHasMultiple = `NULL`
	)		const

Retrieve a boolean value for a specific key. If multiple keys are enabled (see SetMultiKey) then only the first value associated with that key will be returned, see GetAllValues for getting all values with multikey.

Strings starting with "t", "y", "on" or "1" are returned as logically true. Strings starting with "f", "n", "of" or "0" are returned as logically false. For all other values the default is returned. Character comparisons are case-insensitive.

Parameters

a_pSection	Section to search
a_pKey	Key to search for
a_bDefault	Value to return if the key is not found
a_pHasMultiple	Optionally receive notification of if there are multiple entries for this key.

Returns: a_nDefault Key was not found in the section; other Value of the key

◆ GetConverter()

template<class SI_CHAR , class SI_STRLESS , class SI_CONVERTER >

Converter CSimpleIniTempl< SI_CHAR, SI_STRLESS, SI_CONVERTER >::GetConverter ( ) const

inline

Return a conversion object to convert text to the same encoding as is used by the Save(), SaveFile() and SaveString() functions. Use this to prepare the strings that you wish to append or prepend to the output INI data.

◆ GetDoubleValue()

template<class SI_CHAR , class SI_STRLESS , class SI_CONVERTER >

double CSimpleIniTempl< SI_CHAR, SI_STRLESS, SI_CONVERTER >::GetDoubleValue	(	const SI_CHAR *	a_pSection,
		const SI_CHAR *	a_pKey,
		double	a_nDefault = `0`,
		bool *	a_pHasMultiple = `NULL`
	)		const

Retrieve a numeric value for a specific key. If multiple keys are enabled (see SetMultiKey) then only the first value associated with that key will be returned, see GetAllValues for getting all values with multikey.

Parameters

a_pSection	Section to search
a_pKey	Key to search for
a_nDefault	Value to return if the key is not found
a_pHasMultiple	Optionally receive notification of if there are multiple entries for this key.

Returns: a_nDefault Key was not found in the section; other Value of the key

◆ GetLongValue()

template<class SI_CHAR , class SI_STRLESS , class SI_CONVERTER >

long CSimpleIniTempl< SI_CHAR, SI_STRLESS, SI_CONVERTER >::GetLongValue	(	const SI_CHAR *	a_pSection,
		const SI_CHAR *	a_pKey,
		long	a_nDefault = `0`,
		bool *	a_pHasMultiple = `NULL`
	)		const

Retrieve a numeric value for a specific key. If multiple keys are enabled (see SetMultiKey) then only the first value associated with that key will be returned, see GetAllValues for getting all values with multikey.

Parameters

a_pSection	Section to search
a_pKey	Key to search for
a_nDefault	Value to return if the key is not found
a_pHasMultiple	Optionally receive notification of if there are multiple entries for this key.

Returns: a_nDefault Key was not found in the section; other Value of the key

◆ GetSection()

template<class SI_CHAR , class SI_STRLESS , class SI_CONVERTER >

const CSimpleIniTempl< SI_CHAR, SI_STRLESS, SI_CONVERTER >::TKeyVal * CSimpleIniTempl< SI_CHAR, SI_STRLESS, SI_CONVERTER >::GetSection ( const SI_CHAR * a_pSection ) const

Retrieve all key and value pairs for a section. The data is returned as a pointer to an STL map and can be iterated or searched as desired. Note that multiple entries for the same key may exist when multiple keys have been enabled.

NOTE! This structure contains only pointers to strings. The actual string data is stored in memory owned by CSimpleIni. Ensure that the CSimpleIni object is not destroyed or Reset() while these strings are in use!

Parameters

a_pSection Name of the section to return

Returns: Section data

◆ GetSectionSize()

template<class SI_CHAR , class SI_STRLESS , class SI_CONVERTER >

int CSimpleIniTempl< SI_CHAR, SI_STRLESS, SI_CONVERTER >::GetSectionSize ( const SI_CHAR * a_pSection ) const

Query the number of keys in a specific section. Note that if multiple keys are enabled, then this value may be different to the number of keys returned by GetAllKeys.

Parameters

a_pSection Section to request data for

Returns: -1 Section does not exist in the file; >=0 Number of keys in the section

◆ GetValue()

template<class SI_CHAR , class SI_STRLESS , class SI_CONVERTER >

const SI_CHAR * CSimpleIniTempl< SI_CHAR, SI_STRLESS, SI_CONVERTER >::GetValue	(	const SI_CHAR *	a_pSection,
		const SI_CHAR *	a_pKey,
		const SI_CHAR *	a_pDefault = `NULL`,
		bool *	a_pHasMultiple = `NULL`
	)		const

Retrieve the value for a specific key. If multiple keys are enabled (see SetMultiKey) then only the first value associated with that key will be returned, see GetAllValues for getting all values with multikey.

NOTE! The returned value is a pointer to string data stored in memory owned by CSimpleIni. Ensure that the CSimpleIni object is not destroyed or Reset while you are using this pointer!

Parameters

a_pSection	Section to search
a_pKey	Key to search for
a_pDefault	Value to return if the key is not found
a_pHasMultiple	Optionally receive notification of if there are multiple entries for this key.

Returns: a_pDefault Key was not found in the section; other Value of the key

◆ IsEmpty()

template<class SI_CHAR , class SI_STRLESS , class SI_CONVERTER >

bool CSimpleIniTempl< SI_CHAR, SI_STRLESS, SI_CONVERTER >::IsEmpty ( ) const

inline

Has any data been loaded

◆ IsMultiKey()

template<class SI_CHAR , class SI_STRLESS , class SI_CONVERTER >

bool CSimpleIniTempl< SI_CHAR, SI_STRLESS, SI_CONVERTER >::IsMultiKey ( ) const

inline

Get the storage format of the INI data.

◆ IsMultiLine()

template<class SI_CHAR , class SI_STRLESS , class SI_CONVERTER >

bool CSimpleIniTempl< SI_CHAR, SI_STRLESS, SI_CONVERTER >::IsMultiLine ( ) const

inline

Query the status of multi-line data

◆ IsUnicode()

template<class SI_CHAR , class SI_STRLESS , class SI_CONVERTER >

bool CSimpleIniTempl< SI_CHAR, SI_STRLESS, SI_CONVERTER >::IsUnicode ( ) const

inline

Get the storage format of the INI data.

◆ KeyExists()

template<class SI_CHAR , class SI_STRLESS , class SI_CONVERTER >

bool CSimpleIniTempl< SI_CHAR, SI_STRLESS, SI_CONVERTER >::KeyExists	(	const SI_CHAR *	a_pSection,
		const SI_CHAR *	a_pKey
	)		const

inline

Test if the key exists in a section. Convenience function.

◆ LoadData() [1/2]

template<class SI_CHAR , class SI_STRLESS , class SI_CONVERTER >

SI_Error CSimpleIniTempl< SI_CHAR, SI_STRLESS, SI_CONVERTER >::LoadData	(	const char *	a_pData,
		size_t	a_uDataLen
	)

Load INI file data direct from memory

Parameters

a_pData	Data to be loaded
a_uDataLen	Length of the data in bytes

Returns: SI_Error See error definitions

◆ LoadData() [2/2]

template<class SI_CHAR , class SI_STRLESS , class SI_CONVERTER >

SI_Error CSimpleIniTempl< SI_CHAR, SI_STRLESS, SI_CONVERTER >::LoadData ( const std::string & a_strData )

inline

Load INI file data direct from a std::string

Parameters

a_strData Data to be loaded

Returns: SI_Error See error definitions

◆ LoadFile() [1/2]

template<class SI_CHAR , class SI_STRLESS , class SI_CONVERTER >

SI_Error CSimpleIniTempl< SI_CHAR, SI_STRLESS, SI_CONVERTER >::LoadFile ( const char * a_pszFile )

Load an INI file from disk into memory

Parameters

a_pszFile Path of the file to be loaded. This will be passed to fopen() and so must be a valid path for the current platform.

Returns: SI_Error See error definitions

◆ LoadFile() [2/2]

template<class SI_CHAR , class SI_STRLESS , class SI_CONVERTER >

SI_Error CSimpleIniTempl< SI_CHAR, SI_STRLESS, SI_CONVERTER >::LoadFile ( FILE * a_fpFile )

Load the file from a file pointer.

Parameters

a_fpFile Valid file pointer to read the file data from. The file will be read until end of file.

Returns: SI_Error See error definitions

◆ Reset()

template<class SI_CHAR , class SI_STRLESS , class SI_CONVERTER >

void CSimpleIniTempl< SI_CHAR, SI_STRLESS, SI_CONVERTER >::Reset

Deallocate all memory stored by this object

◆ Save() [1/2]

template<class SI_CHAR , class SI_STRLESS , class SI_CONVERTER >

SI_Error CSimpleIniTempl< SI_CHAR, SI_STRLESS, SI_CONVERTER >::Save	(	OutputWriter &	a_oOutput,
		bool	a_bAddSignature = `false`
	)		const

Save the INI data. The data will be written to the output device in a format appropriate to the current data, selected by:

SI_CHAR	FORMAT
char	same format as when loaded (MBCS or UTF-8)
wchar_t	UTF-8
other	UTF-8

Note that comments from the original data is preserved as per the documentation on comments. The order of the sections and values from the original file will be preserved.

Any data prepended or appended to the output device must use the the same format (MBCS or UTF-8). You may use the GetConverter() method to convert text to the correct format regardless of the output format being used by SimpleIni.

To add a BOM to UTF-8 data, write it out manually at the very beginning like is done in SaveFile when a_bUseBOM is true.

Parameters

a_oOutput	Output writer to write the data to.
a_bAddSignature	Prepend the UTF-8 BOM if the output data is in UTF-8 format. If it is not UTF-8 then this value is ignored. Do not set this to true if anything has already been written to the OutputWriter.

Returns: SI_Error See error definitions

◆ Save() [2/2]

template<class SI_CHAR , class SI_STRLESS , class SI_CONVERTER >

SI_Error CSimpleIniTempl< SI_CHAR, SI_STRLESS, SI_CONVERTER >::Save	(	std::string &	a_sBuffer,
		bool	a_bAddSignature = `false`
	)		const

inline

Append the INI data to a string. See Save() for details.

Parameters

a_sBuffer	String to have the INI data appended to.
a_bAddSignature	Prepend the UTF-8 BOM if the output data is in UTF-8 format. If it is not UTF-8 then this value is ignored. Do not set this to true if anything has already been written to the string.

Returns: SI_Error See error definitions

◆ SaveFile() [1/2]

template<class SI_CHAR , class SI_STRLESS , class SI_CONVERTER >

SI_Error CSimpleIniTempl< SI_CHAR, SI_STRLESS, SI_CONVERTER >::SaveFile	(	const char *	a_pszFile,
		bool	a_bAddSignature = `true`
	)		const

Save an INI file from memory to disk

Parameters

a_pszFile	Path of the file to be saved. This will be passed to fopen() and so must be a valid path for the current platform.
a_bAddSignature	Prepend the UTF-8 BOM if the output data is in UTF-8 format. If it is not UTF-8 then this parameter is ignored.

Returns: SI_Error See error definitions

◆ SaveFile() [2/2]

template<class SI_CHAR , class SI_STRLESS , class SI_CONVERTER >

SI_Error CSimpleIniTempl< SI_CHAR, SI_STRLESS, SI_CONVERTER >::SaveFile	(	FILE *	a_pFile,
		bool	a_bAddSignature = `false`
	)		const

Save the INI data to a file. See Save() for details.

Parameters

a_pFile	Handle to a file. File should be opened for binary output.
a_bAddSignature	Prepend the UTF-8 BOM if the output data is in UTF-8 format. If it is not UTF-8 then this value is ignored. Do not set this to true if anything has already been written to the file.

Returns: SI_Error See error definitions

◆ SectionExists()

template<class SI_CHAR , class SI_STRLESS , class SI_CONVERTER >

bool CSimpleIniTempl< SI_CHAR, SI_STRLESS, SI_CONVERTER >::SectionExists ( const SI_CHAR * a_pSection ) const

inline

Test if a section exists. Convenience function

◆ SetAllowKeyOnly()

template<class SI_CHAR , class SI_STRLESS , class SI_CONVERTER >

void CSimpleIniTempl< SI_CHAR, SI_STRLESS, SI_CONVERTER >::SetAllowKeyOnly ( bool a_bAllowKeyOnly = true )

inline

When reading/writing an ini file, do we require every key to have an equals sign to delineate a valid key value. If false, then every valid key must have an equals sign and any lines without an equals sign is ignored. If true then keys do not require an equals sign to be considered a key. Note that this means that any non-commented line of text would become a key.

Parameters

a_bAllowKeyOnly Permit keys without an equals sign or value.

◆ SetBoolValue()

template<class SI_CHAR , class SI_STRLESS , class SI_CONVERTER >

SI_Error CSimpleIniTempl< SI_CHAR, SI_STRLESS, SI_CONVERTER >::SetBoolValue	(	const SI_CHAR *	a_pSection,
		const SI_CHAR *	a_pKey,
		bool	a_bValue,
		const SI_CHAR *	a_pComment = `NULL`,
		bool	a_bForceReplace = `false`
	)

Add or update a boolean value. This will always insert when multiple keys are enabled.

Parameters

a_pSection	Section to add or update
a_pKey	Key to add or update.
a_bValue	Value to set.
a_pComment	Comment to be associated with the key. See the notes on SetValue() for comments.
a_bForceReplace	Should all existing values in a multi-key INI file be replaced with this entry. This option has no effect if not using multi-key files. The difference between Delete/SetBoolValue and SetBoolValue with a_bForceReplace = true, is that the load order and comment will be preserved this way.

Returns: SI_Error See error definitions; SI_UPDATED Value was updated; SI_INSERTED Value was inserted

◆ SetDoubleValue()

template<class SI_CHAR , class SI_STRLESS , class SI_CONVERTER >

SI_Error CSimpleIniTempl< SI_CHAR, SI_STRLESS, SI_CONVERTER >::SetDoubleValue	(	const SI_CHAR *	a_pSection,
		const SI_CHAR *	a_pKey,
		double	a_nValue,
		const SI_CHAR *	a_pComment = `NULL`,
		bool	a_bForceReplace = `false`
	)

Add or update a double value. This will always insert when multiple keys are enabled.

Parameters

a_pSection	Section to add or update
a_pKey	Key to add or update.
a_nValue	Value to set.
a_pComment	Comment to be associated with the key. See the notes on SetValue() for comments.
a_bForceReplace	Should all existing values in a multi-key INI file be replaced with this entry. This option has no effect if not using multi-key files. The difference between Delete/SetDoubleValue and SetDoubleValue with a_bForceReplace = true, is that the load order and comment will be preserved this way.

Returns: SI_Error See error definitions; SI_UPDATED Value was updated; SI_INSERTED Value was inserted

◆ SetLongValue()

template<class SI_CHAR , class SI_STRLESS , class SI_CONVERTER >

SI_Error CSimpleIniTempl< SI_CHAR, SI_STRLESS, SI_CONVERTER >::SetLongValue	(	const SI_CHAR *	a_pSection,
		const SI_CHAR *	a_pKey,
		long	a_nValue,
		const SI_CHAR *	a_pComment = `NULL`,
		bool	a_bUseHex = `false`,
		bool	a_bForceReplace = `false`
	)

Add or update a numeric value. This will always insert when multiple keys are enabled.

Parameters

a_pSection	Section to add or update
a_pKey	Key to add or update.
a_nValue	Value to set.
a_pComment	Comment to be associated with the key. See the notes on SetValue() for comments.
a_bUseHex	By default the value will be written to the file in decimal format. Set this to true to write it as hexadecimal.
a_bForceReplace	Should all existing values in a multi-key INI file be replaced with this entry. This option has no effect if not using multi-key files. The difference between Delete/SetLongValue and SetLongValue with a_bForceReplace = true, is that the load order and comment will be preserved this way.

Returns: SI_Error See error definitions; SI_UPDATED Value was updated; SI_INSERTED Value was inserted

◆ SetMultiKey()

template<class SI_CHAR , class SI_STRLESS , class SI_CONVERTER >

void CSimpleIniTempl< SI_CHAR, SI_STRLESS, SI_CONVERTER >::SetMultiKey ( bool a_bAllowMultiKey = true )

inline

Should multiple identical keys be permitted in the file. If set to false then the last value encountered will be used as the value of the key. If set to true, then all values will be available to be queried. For example, with the following input:

[section]
test=value1
test=value2

Then with SetMultiKey(true), both of the values "value1" and "value2" will be returned for the key test. If SetMultiKey(false) is used, then the value for "test" will only be "value2". This value may be changed at any time.

Parameters

a_bAllowMultiKey Allow multi-keys in the source?

◆ SetMultiLine()

template<class SI_CHAR , class SI_STRLESS , class SI_CONVERTER >

void CSimpleIniTempl< SI_CHAR, SI_STRLESS, SI_CONVERTER >::SetMultiLine ( bool a_bAllowMultiLine = true )

inline

Should data values be permitted to span multiple lines in the file. If set to false then the multi-line construct <<<TAG as a value will be returned as is instead of loading the data. This value may be changed at any time.

Parameters

a_bAllowMultiLine Allow multi-line values in the source?

◆ SetQuotes()

template<class SI_CHAR , class SI_STRLESS , class SI_CONVERTER >

void CSimpleIniTempl< SI_CHAR, SI_STRLESS, SI_CONVERTER >::SetQuotes ( bool a_bParseQuotes = true )

inline

Should we recognise and parse quotes in single line values?

Parameters

a_bParseQuotes Parse quoted data in values?

◆ SetSpaces()

template<class SI_CHAR , class SI_STRLESS , class SI_CONVERTER >

void CSimpleIniTempl< SI_CHAR, SI_STRLESS, SI_CONVERTER >::SetSpaces ( bool a_bSpaces = true )

inline

Should spaces be added around the equals sign when writing key/value pairs out. When true, the result will be "key = value". When false, the result will be "key=value". This value may be changed at any time.

Parameters

a_bSpaces Add spaces around the equals sign?

◆ SetUnicode()

template<class SI_CHAR , class SI_STRLESS , class SI_CONVERTER >

void CSimpleIniTempl< SI_CHAR, SI_STRLESS, SI_CONVERTER >::SetUnicode ( bool a_bIsUtf8 = true )

inline

Set the storage format of the INI data. This affects both the loading and saving of the INI data using all of the Load/Save API functions. This value cannot be changed after any INI data has been loaded.

If the file is not set to Unicode (UTF-8), then the data encoding is assumed to be the OS native encoding. This encoding is the system locale on Linux/Unix and the legacy MBCS encoding on Windows NT/2K/XP. If the storage format is set to Unicode then the file will be loaded as UTF-8 encoded data regardless of the native file encoding. If SI_CHAR == char then all of the char* parameters take and return UTF-8 encoded data regardless of the system locale.

Parameters

a_bIsUtf8 Assume UTF-8 encoding for the source?

◆ SetValue()

template<class SI_CHAR , class SI_STRLESS , class SI_CONVERTER >

SI_Error CSimpleIniTempl< SI_CHAR, SI_STRLESS, SI_CONVERTER >::SetValue	(	const SI_CHAR *	a_pSection,
		const SI_CHAR *	a_pKey,
		const SI_CHAR *	a_pValue,
		const SI_CHAR *	a_pComment = `NULL`,
		bool	a_bForceReplace = `false`
	)

inline

Add or update a section or value. This will always insert when multiple keys are enabled.

Parameters

a_pSection	Section to add or update
a_pKey	Key to add or update. Set to NULL to create an empty section.
a_pValue	Value to set. Set to NULL to create an empty section.
a_pComment	Comment to be associated with the section or the key. If a_pKey is NULL then it will be associated with the section, otherwise the key. Note that a comment may be set ONLY when the section or key is first created (i.e. when this function returns the value SI_INSERTED). If you wish to create a section with a comment then you need to create the section separately to the key. The comment string must be in full comment form already (have a comment character starting every line).
a_bForceReplace	Should all existing values in a multi-key INI file be replaced with this entry. This option has no effect if not using multi-key files. The difference between Delete/SetValue and SetValue with a_bForceReplace = true, is that the load order and comment will be preserved this way.

Returns: SI_Error See error definitions; SI_UPDATED Value was updated; SI_INSERTED Value was inserted

◆ UsingQuotes()

template<class SI_CHAR , class SI_STRLESS , class SI_CONVERTER >

bool CSimpleIniTempl< SI_CHAR, SI_STRLESS, SI_CONVERTER >::UsingQuotes ( ) const

inline

Are we permitting keys and values to be quoted?

◆ UsingSpaces()

template<class SI_CHAR , class SI_STRLESS , class SI_CONVERTER >

bool CSimpleIniTempl< SI_CHAR, SI_STRLESS, SI_CONVERTER >::UsingSpaces ( ) const

inline

Query the status of spaces output

The documentation for this class was generated from the following file:

SimpleIni.h

Classes

Public Types

Public Member Functions

Detailed Description

template<class SI_CHAR, class SI_STRLESS, class SI_CONVERTER> class CSimpleIniTempl< SI_CHAR, SI_STRLESS, SI_CONVERTER >

Member Typedef Documentation

◆ TKeyVal

◆ TNamesDepend

◆ TSection

Constructor & Destructor Documentation

◆ CSimpleIniTempl()

◆ ~CSimpleIniTempl()

Member Function Documentation

◆ Delete()

◆ DeleteValue()

◆ GetAllKeys()

◆ GetAllowKeyOnly()

◆ GetAllSections()

◆ GetAllValues()

◆ GetBoolValue()

◆ GetConverter()

◆ GetDoubleValue()

◆ GetLongValue()

◆ GetSection()

◆ GetSectionSize()

◆ GetValue()

◆ IsEmpty()

◆ IsMultiKey()

◆ IsMultiLine()

◆ IsUnicode()

◆ KeyExists()

◆ LoadData() [1/2]

◆ LoadData() [2/2]

◆ LoadFile() [1/2]

◆ LoadFile() [2/2]

◆ Reset()

◆ Save() [1/2]

◆ Save() [2/2]

◆ SaveFile() [1/2]

◆ SaveFile() [2/2]

◆ SectionExists()

◆ SetAllowKeyOnly()

◆ SetBoolValue()

◆ SetDoubleValue()

◆ SetLongValue()

◆ SetMultiKey()

◆ SetMultiLine()

◆ SetQuotes()

◆ SetSpaces()

◆ SetUnicode()

◆ SetValue()

◆ UsingQuotes()

◆ UsingSpaces()

template<class SI_CHAR, class SI_STRLESS, class SI_CONVERTER>
class CSimpleIniTempl< SI_CHAR, SI_STRLESS, SI_CONVERTER >