Encapsulates the Windows INI file interface Get/SetPrivateProfileXXX functions. More...

#include <owl/configfl.h>

Inheritance diagram for owl::TIniConfigFile:

Public Member Functions
	TIniConfigFile (const tstring &name)

virtual	~TIniConfigFile ()

virtual uint	ReadSection (LPCTSTR section, TCHAR *buffer, uint bufSize) const

virtual uint	ReadSections (TCHAR *buffer, uint bufSize) const

virtual bool	EraseSection (LPCTSTR section)
	This method deletes the specified section.

virtual bool	EraseEntry (LPCTSTR section, LPCTSTR entry)
	This method deletes the specified entry.

virtual void	UpdateFile ()

virtual uint	ReadString (LPCTSTR section, LPCTSTR entry, TCHAR *buffer, uint bufSize, LPCTSTR defstr=0) const
	This method is the base method for reading strings.

virtual bool	WriteString (LPCTSTR section, LPCTSTR entry, LPCTSTR value)
	This method is the low-level method for writing strings.

virtual bool	ReadData (LPCTSTR section, LPCTSTR entry, void *buffer, uint size) const
	This method reads binary data.

virtual bool	WriteData (LPCTSTR section, LPCTSTR entry, void *buffer, uint size)
	This method writes binary data.

virtual uint	ReadSection (LPCTSTR section, TCHAR *buffer, uint bufSize) const=0

int	ReadSection (const tstring &section, tstring &buffer) const

virtual uint	ReadSections (TCHAR *sections, uint bufSize) const=0

int	ReadSections (tstring &sections) const

virtual bool	EraseSection (LPCTSTR section)=0

bool	EraseSection (const tstring &section)

virtual bool	EraseEntry (LPCTSTR section, LPCTSTR entry)=0

bool	EraseEntry (const tstring &section, const tstring &entry)

virtual uint	ReadString (LPCTSTR section, LPCTSTR entry, TCHAR *buffer, uint bufSize, LPCTSTR defstr=0) const=0

uint	ReadString (const tstring &section, const tstring &entry, tstring &buffer, LPCTSTR defstr=0) const
	String-aware overload.

uint	ReadString (const tstring &section, const tstring &entry, tstring &buffer, const tstring &defstr) const

virtual bool	WriteString (LPCTSTR section, LPCTSTR entry, LPCTSTR value)=0

bool	WriteString (const tstring &section, const tstring &entry, const tstring &value)

virtual bool	ReadData (LPCTSTR section, LPCTSTR entry, void *buffer, uint size) const
	This method reads binary data.

bool	ReadData (const tstring &section, const tstring &entry, void *buffer, uint size) const

virtual bool	WriteData (LPCTSTR section, LPCTSTR entry, void *buffer, uint size)
	This method writes binary data.

bool	WriteData (const tstring &section, const tstring &entry, void *buffer, uint size)

Public Member Functions inherited from owl::TConfigFile
	TConfigFile (const tstring &name)
	Constructs instance and sets FileName to name.

virtual	~TConfigFile ()
	Destroys the instance.

const tstring &	GetFileName () const

virtual void	LoadValues (const TConfigFile &file)

virtual bool	SectionExists (LPCTSTR section) const

virtual int	ReadInteger (LPCTSTR section, LPCTSTR entry, int defint=0) const
	This method reads an integer.

virtual bool	WriteInteger (LPCTSTR section, LPCTSTR entry, int value)
	This method writes an integer. We format it as a string.

bool	SectionExists (const tstring &section) const

int	ReadSection (const tstring &section, tstring &buffer) const

int	ReadSections (tstring &sections) const

bool	EraseSection (const tstring &section)

bool	EraseEntry (const tstring &section, const tstring &entry)

uint	ReadString (const tstring &section, const tstring &entry, tstring &buffer, LPCTSTR defstr=0) const
	String-aware overload.

uint	ReadString (const tstring &section, const tstring &entry, tstring &buffer, const tstring &defstr) const

bool	WriteString (const tstring &section, const tstring &entry, const tstring &value)

bool	ReadData (const tstring &section, const tstring &entry, void *buffer, uint size) const

bool	WriteData (const tstring &section, const tstring &entry, void *buffer, uint size)

int	ReadInteger (const tstring &section, const tstring &entry, int defint=0) const

bool	WriteInteger (const tstring &section, const tstring &entry, int value)

double	ReadDouble (LPCTSTR section, LPCTSTR entry, double defval=0.0) const

bool	WriteDouble (LPCTSTR section, LPCTSTR entry, double value)
	This method writes an integer.

double	ReadDouble (const tstring &section, const tstring &entry, double defval=0.0) const

bool	WriteDouble (const tstring &section, const tstring &entry, double value)

bool	ReadBool (LPCTSTR section, LPCTSTR entry, bool defval=false) const
	This method reads a boolean value.

bool	WriteBool (LPCTSTR section, LPCTSTR entry, bool val)
	This method writes a bool.

bool	ReadBool (const tstring &section, const tstring &entry, bool defval=false) const

bool	WriteBool (const tstring &section, const tstring &entry, bool val)

bool	ReadDate (LPCTSTR section, LPCTSTR entry, TDate &value) const

bool	WriteDate (LPCTSTR section, LPCTSTR entry, const TDate &val)

bool	ReadDate (const tstring &section, const tstring &entry, TDate &value) const

bool	WriteDate (const tstring &section, const tstring &entry, const TDate &val)

bool	ReadSystemTime (LPCTSTR section, LPCTSTR entry, TSystemTime &val) const

bool	WriteSystemTime (LPCTSTR section, LPCTSTR entry, const TSystemTime &val)

bool	ReadSystemTime (const tstring &section, const tstring &entry, TSystemTime &val) const

bool	WriteSystemTime (const tstring &section, const tstring &entry, const TSystemTime &val)

bool	ReadTime (LPCTSTR section, LPCTSTR entry, TTime &val) const

bool	WriteTime (LPCTSTR section, LPCTSTR entry, TTime &val)

bool	ReadTime (const tstring &section, const tstring &entry, TTime &val) const

bool	WriteTime (const tstring &section, const tstring &entry, TTime &val)

bool	ReadFont (LPCTSTR section, LPCTSTR entry, LOGFONT &font) const
	This method will take a profile string of the form:

bool	WriteFont (LPCTSTR section, LPCTSTR entry, const LOGFONT &font)
	This method writes a font description in the following format:

bool	ReadFont (const tstring &section, const tstring &entry, LOGFONT &font) const

bool	WriteFont (const tstring &section, const tstring &entry, const LOGFONT &font)

bool	ReadColor (LPCTSTR section, LPCTSTR entry, TColor &color) const
	This method reads an RGB color.

bool	WriteColor (LPCTSTR section, LPCTSTR entry, const TColor &clr)
	This method writes an RGB color.

bool	ReadColor (const tstring &section, const tstring &entry, TColor &color) const

bool	WriteColor (const tstring &section, const tstring &entry, const TColor &clr)

bool	ReadRect (LPCTSTR section, LPCTSTR entry, TRect &val) const
	This method reads a rectangle.

bool	WriteRect (LPCTSTR section, LPCTSTR entry, const TRect &rc)
	This method writes a rectangle.

bool	ReadRect (const tstring &section, const tstring &entry, TRect &val) const

bool	WriteRect (const tstring &section, const tstring &entry, const TRect &rc)

bool	ReadPoint (LPCTSTR section, LPCTSTR entry, TPoint &val) const

bool	WritePoint (LPCTSTR section, LPCTSTR entry, const TPoint &point)
	This method writes a TPoint.

bool	ReadPoint (const tstring &section, const tstring &entry, TPoint &val) const

bool	WritePoint (const tstring &section, const tstring &entry, const TPoint &point)

bool	ReadSize (LPCTSTR section, LPCTSTR entry, TSize &sz) const

bool	WriteSize (LPCTSTR section, LPCTSTR entry, const TSize &size)
	This method writes a TSize.

bool	ReadSize (const tstring &section, const tstring &entry, TSize &sz) const

bool	WriteSize (const tstring &section, const tstring &entry, const TSize &size)

Additional Inherited Members
Static Public Member Functions inherited from owl::TConfigFile
static void	SetPrecision (int newprec=-1)

static int	GetPrecision ()

Static Protected Member Functions inherited from owl::TConfigFile
static bool	StringToBool (LPCTSTR str, bool *val)
	This static method converts a string to a bool, accepting most common boolean keywords: yes, on, true and 1.

static tstring	BoolToString (bool val)
	This static method returns yes or no given a boolean value.

Protected Attributes inherited from owl::TConfigFile
tstring	FileName

Static Protected Attributes inherited from owl::TConfigFile
static int	DefaultPrecision = -1

Detailed Description

Encapsulates the Windows INI file interface Get/SetPrivateProfileXXX functions.

Definition at line 249 of file configfl.h.

Constructor & Destructor Documentation

◆ TIniConfigFile()

owl::TIniConfigFile::TIniConfigFile ( const tstring & name )

inline

Definition at line 252 of file configfl.h.

◆ ~TIniConfigFile()

virtual owl::TIniConfigFile::~TIniConfigFile ( )

inlinevirtual

Definition at line 255 of file configfl.h.

Member Function Documentation

◆ EraseEntry() [1/3]

bool owl::TConfigFile::EraseEntry	(	const tstring &	section,
		const tstring &	entry )

inline

Definition at line 86 of file configfl.h.

◆ EraseEntry() [2/3]

bool owl::TIniConfigFile::EraseEntry	(	LPCTSTR	section,
		LPCTSTR	entry )

virtual

This method deletes the specified entry.

Implements owl::TConfigFile.

Definition at line 940 of file configfl.cpp.

References owl::TConfigFile::FileName, and PRECONDITION.

◆ EraseEntry() [3/3]

virtual bool owl::TConfigFile::EraseEntry	(	LPCTSTR	section,
		LPCTSTR	entry )

virtual

Implements owl::TConfigFile.

◆ EraseSection() [1/3]

bool owl::TConfigFile::EraseSection ( const tstring & section )

inline

Definition at line 85 of file configfl.h.

◆ EraseSection() [2/3]

bool owl::TIniConfigFile::EraseSection ( LPCTSTR section )

virtual

This method deletes the specified section.

Implements owl::TConfigFile.

Definition at line 930 of file configfl.cpp.

References owl::TConfigFile::FileName, and PRECONDITION.

◆ EraseSection() [3/3]

virtual bool owl::TConfigFile::EraseSection ( LPCTSTR section )

virtual

Implements owl::TConfigFile.

◆ ReadData() [1/3]

bool owl::TConfigFile::ReadData	(	const tstring &	section,
		const tstring &	entry,
		void *	buffer,
		uint	size ) const

inline

Definition at line 93 of file configfl.h.

◆ ReadData() [2/3]

bool owl::TIniConfigFile::ReadData	(	LPCTSTR	section,
		LPCTSTR	entry,
		void *	buffer,
		uint	size ) const

virtual

This method reads binary data.

Reimplemented from owl::TConfigFile.

Definition at line 977 of file configfl.cpp.

References owl::TConfigFile::FileName, and PRECONDITION.

◆ ReadData() [3/3]

bool owl::TConfigFile::ReadData	(	LPCTSTR	section,
		LPCTSTR	entry,
		void *	buffer,
		uint	size ) const

virtual

This method reads binary data.

Reimplemented from owl::TConfigFile.

Definition at line 76 of file configfl.cpp.

◆ ReadSection() [1/3]

int owl::TConfigFile::ReadSection	(	const tstring &	section,
		tstring &	buffer ) const

Definition at line 83 of file configfl.cpp.

◆ ReadSection() [2/3]

uint owl::TIniConfigFile::ReadSection	(	LPCTSTR	section,
		TCHAR *	buffer,
		uint	bufSize ) const

virtual

Implements owl::TConfigFile.

Definition at line 916 of file configfl.cpp.

References _T, owl::TConfigFile::FileName, and PRECONDITION.

◆ ReadSection() [3/3]

virtual uint owl::TConfigFile::ReadSection	(	LPCTSTR	section,
		TCHAR *	buffer,
		uint	bufSize ) const

virtual

Implements owl::TConfigFile.

◆ ReadSections() [1/3]

uint owl::TIniConfigFile::ReadSections	(	TCHAR *	buffer,
		uint	bufSize ) const

virtual

Implements owl::TConfigFile.

Definition at line 922 of file configfl.cpp.

References _T, owl::TConfigFile::FileName, and PRECONDITION.

◆ ReadSections() [2/3]

virtual uint owl::TConfigFile::ReadSections	(	TCHAR *	sections,
		uint	bufSize ) const

virtual

Implements owl::TConfigFile.

◆ ReadSections() [3/3]

int owl::TConfigFile::ReadSections ( tstring & sections ) const

Definition at line 84 of file configfl.cpp.

◆ ReadString() [1/4]

uint owl::TConfigFile::ReadString	(	const tstring &	section,
		const tstring &	entry,
		tstring &	buffer,
		const tstring &	defstr ) const

inline

Definition at line 89 of file configfl.h.

◆ ReadString() [2/4]

uint owl::TConfigFile::ReadString	(	const tstring &	section,
		const tstring &	entry,
		tstring &	buffer,
		LPCTSTR	defstr = 0 ) const

String-aware overload.

Definition at line 88 of file configfl.cpp.

◆ ReadString() [3/4]

uint owl::TIniConfigFile::ReadString	(	LPCTSTR	section,
		LPCTSTR	entry,
		TCHAR *	buffer,
		uint	bufSize,
		LPCTSTR	def = 0 ) const

virtual

This method is the base method for reading strings.

Returns: The number of characters written to the output buffer (excluding the null-terminator, which is also written).

Note: If the buffer is too small to hold the whole string, the string is truncated to (bufSize - 1) characters and null-terminated.

Implements owl::TConfigFile.

Definition at line 960 of file configfl.cpp.

References _T, owl::TConfigFile::FileName, and PRECONDITION.

◆ ReadString() [4/4]

virtual uint owl::TConfigFile::ReadString	(	LPCTSTR	section,
		LPCTSTR	entry,
		TCHAR *	buffer,
		uint	bufSize,
		LPCTSTR	defstr = 0 ) const

virtual

Implements owl::TConfigFile.

◆ UpdateFile()

void owl::TIniConfigFile::UpdateFile ( )

virtual

Implements owl::TConfigFile.

Definition at line 948 of file configfl.cpp.

References owl::TConfigFile::FileName.

◆ WriteData() [1/3]

bool owl::TConfigFile::WriteData	(	const tstring &	section,
		const tstring &	entry,
		void *	buffer,
		uint	size )

inline

Definition at line 94 of file configfl.h.

◆ WriteData() [2/3]

bool owl::TIniConfigFile::WriteData	(	LPCTSTR	section,
		LPCTSTR	entry,
		void *	buffer,
		uint	size )

virtual

This method writes binary data.

Reimplemented from owl::TConfigFile.

Definition at line 985 of file configfl.cpp.

References owl::TConfigFile::FileName, and PRECONDITION.

◆ WriteData() [3/3]

bool owl::TConfigFile::WriteData	(	LPCTSTR	section,
		LPCTSTR	entry,
		void *	buffer,
		uint	size )

virtual

This method writes binary data.

Reimplemented from owl::TConfigFile.

Definition at line 77 of file configfl.cpp.

◆ WriteString() [1/3]

bool owl::TConfigFile::WriteString	(	const tstring &	section,
		const tstring &	entry,
		const tstring &	value )

inline

Definition at line 91 of file configfl.h.

◆ WriteString() [2/3]

bool owl::TIniConfigFile::WriteString	(	LPCTSTR	section,
		LPCTSTR	entry,
		LPCTSTR	value )

virtual

This method is the low-level method for writing strings.

Implements owl::TConfigFile.

Definition at line 969 of file configfl.cpp.

References owl::TConfigFile::FileName, and PRECONDITION.

◆ WriteString() [3/3]

virtual bool owl::TConfigFile::WriteString	(	LPCTSTR	section,
		LPCTSTR	entry,
		LPCTSTR	value )

virtual

Implements owl::TConfigFile.

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

include/owl/configfl.h
source/owlcore/configfl.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ TIniConfigFile()

◆ ~TIniConfigFile()

Member Function Documentation

◆ EraseEntry() [1/3]

◆ EraseEntry() [2/3]

◆ EraseEntry() [3/3]

◆ EraseSection() [1/3]

◆ EraseSection() [2/3]

◆ EraseSection() [3/3]

◆ ReadData() [1/3]

◆ ReadData() [2/3]

◆ ReadData() [3/3]

◆ ReadSection() [1/3]

◆ ReadSection() [2/3]

◆ ReadSection() [3/3]

◆ ReadSections() [1/3]

◆ ReadSections() [2/3]

◆ ReadSections() [3/3]

◆ ReadString() [1/4]

◆ ReadString() [2/4]

◆ ReadString() [3/4]

◆ ReadString() [4/4]

◆ UpdateFile()

◆ WriteData() [1/3]

◆ WriteData() [2/3]

◆ WriteData() [3/3]

◆ WriteString() [1/3]

◆ WriteString() [2/3]

◆ WriteString() [3/3]