Referencia de la Clase zak::ConfigFile

Lista de todos los miembros.

Métodos públicos
bool	Load (const char *szFilename)
int	ReadInteger (const char *pszSection, const char *pszOption, int iDefaultValue)
long	ReadLong (const char *pszSection, const char *pszOption, long lDefaultValue)
DWORD	ReadDWord (const char *pszSection, const char *pszOption, DWORD DefaultValue)
bool	ReadBoolean (const char *pszSection, const char *pszOption, bool bDefaultValue)
float	ReadFloat (const char *pszSection, const char *pszOption, float fDefaultValue)
char *	ReadString (const char *pszSection, const char *pszOption, const char *pszDefaultValue)
	ConfigFile ()
	ConfigFile (const char *Filename)
	~ConfigFile ()
Amigas
class	ScriptMgr

---

Descripción detallada

Esta clase analiza gramaticalmente archivos '.ini'. Ejemplo de uso:

        ; Este es un archivo con extensión .ini
        [SECCION] ; Los comentarios se escriben anteponiendo un ';'
        ValorInt = 50
        ValorFloat = 10.0
        Cadena = "Hola, Mundo!"

Código:

        ConfigFile *parser = new ConfigFile();
        
        if (!parser->Load("ruta/archivo.ini")) {
                delete parser;
                return false;
        }

        int         valor1 = parser->ReadInteger("SECCION", "ValorInt", 0);
        float   valor2 = parser->ReadFloat("SECCION", "ValorFloat", 0.0f);
        char    *cadena = parser->ReadString("SECCION", "Cadena", "\0");

Autor:

Juan Pablo "McKrackeN" Bettini

---

Documentación del constructor y destructor

zak::ConfigFile::ConfigFile

(

)

Constructor.

zak::ConfigFile::ConfigFile

(

const char *

Filename

)

Constructor.

Parámetros:

Nombre

del archivo a abrir.

zak::ConfigFile::~ConfigFile

(

)

Destructor.

---

Documentación de las funciones miembro

bool zak::ConfigFile::Load

(

const char *

szFilename

)

Abre el archivo a analizar.

Parámetros:

szFilename

Nombre del archivo a analizar.

Devuelve:

Retorna verdadero si la operación fue exitosa

int zak::ConfigFile::ReadInteger	(	const char *	pszSection,
		const char *	pszOption,
		int	iDefaultValue
	)

Lee un número entero del archivo analizado.

Parámetros:

	Sección	de la cual buscar la opción
	Opción	a buscar
	Valor	por defecto en el caso de no encontrar la opción buscada

Devuelve:

Retorna el valor encontrado o el valor por defecto en caso de haber algún error.

long zak::ConfigFile::ReadLong	(	const char *	pszSection,
		const char *	pszOption,
		long	lDefaultValue
	)

Lee un número entero largo del archivo analizado.

Parámetros:

	Sección	de la cual buscar la opción
	Opción	a buscar
	Valor	por defecto en el caso de no encontrar la opción buscada

Devuelve:

Retorna el valor encontrado o el valor por defecto en caso de haber algún error.

DWORD zak::ConfigFile::ReadDWord	(	const char *	pszSection,
		const char *	pszOption,
		DWORD	DefaultValue
	)

Lee un número DWORD del archivo analizado.

Parámetros:

	Sección	de la cual buscar la opción
	Opción	a buscar
	Valor	por defecto en el caso de no encontrar la opción buscada

Devuelve:

Retorna el valor encontrado o el valor por defecto en caso de haber algún error.

bool zak::ConfigFile::ReadBoolean	(	const char *	pszSection,
		const char *	pszOption,
		bool	bDefaultValue
	)

Lee un número booleano del archivo analizado.

Parámetros:

	Sección	de la cual buscar la opción
	Opción	a buscar
	Valor	por defecto en el caso de no encontrar la opción buscada

Devuelve:

Retorna el valor encontrado o el valor por defecto en caso de haber algún error.

float zak::ConfigFile::ReadFloat	(	const char *	pszSection,
		const char *	pszOption,
		float	fDefaultValue
	)

Lee un número decimal del archivo analizado.

Parámetros:

	Sección	de la cual buscar la opción
	Opción	a buscar
	Valor	por defecto en el caso de no encontrar la opción buscada

Devuelve:

Retorna el valor encontrado o el valor por defecto en caso de haber algún error.

char * zak::ConfigFile::ReadString	(	const char *	pszSection,
		const char *	pszOption,
		const char *	pszDefaultValue
	)

Lee una cadena de caracteres del archivo analizado.

Parámetros:

	Sección	de la cual buscar la opción
	Opción	a buscar
	Cadena	de caraceteres por defecto en el caso de no encontrar la opción buscada

Devuelve:

Retorna la cadena encontrada encontrado o el valor por defecto en caso de haber algún error.

---

La documentación para esta clase fué generada a partir de los siguientes archivos:

• ConfigFile.h
• ConfigFile.cpp

---