Profile

• support: raul.jrz@gmail.com
• url: http://rauljrz.github.io/
• comment in http://rinconfox.com
• freelancer in http://pph.me/rauljrz

Do you like this project? Support it by donating

• Buy me a coffee
• Paypal: Si te sirvio, invitame un café o una cerveza
• Bitcoin:

Table of contents

• Introduction
• How to use
• Dependencies
• Installation
• Auxiliary Methods
• Main Methods
• Author
• License

Introduction

Esta clase tiene por objeto manejar los archivos de configuración .ini comumente usado en windows. Tiene la capacidad de crear un archivo, leer, modificar el contenido de una clave y de grabar las modificaciones.

How to use

Para hacer uso de la clase, esta debe ser instanciada. Una vez instanciado, para leer el contenido de un archivo existente, debes usar el metodo .read("nombrearchivo.ini").

Para recuperar una clave de una determinada sección usar el metodo .getValue("Data Store","BackEnd").

Para grabar el metodo es, .save(). Y para grabar en un nuevo archivo el método .saveTo("nuevoArchivo.ini").

Dependencies

https://github.com/raulvfp/catchException Para el control de las excepciones.

Installation

git clone https://github.com/raulvfp/profile.git profile

Auxiliary methods

• isSuccess() : Devuelve .T. si tuvo exito la última operación, de lo contrario .F.
• isError() : Devuelve .T. si tuvo error la última operación, de lo contrario .F.
• getMsgError(): Si la última operación dio error, contiene el Mensaje de Error, de lo contrario .null.
• getFileName(): Devuelve el nombre del archivo profile con el cual se esta trabajando.

⬆ back to top

Main methods

• delete(cSection AS CHARACTER, cKey AS CHARACTER)

  Elimina un Clave (cKey) de una Sección (cSection) determinada.

• getValue(cSection AS CHARACTER, cKey AS CHARACTER)

  Devuelve el valor de una Clave (cKey) de una Seccón (cSection) determinada.

• read(cFileName AS CHARACTER)

  Lee el contenido de un archivo Profile (cFileName) y lo carga en un objeto.

• save()

  Guarda las modificaciones en disco.

• saveTo(cNewFile AS CHARACTER)

  Guarda los datos en un nuevo archivo Profile(cFileName).

• setValue(cSection AS CHARACTER, cKey AS CHARACTER, eValue)

  Asigna un valor (eValue) en una clave (cKey) de una seccón (cSection) determinada.

⬆ back to top

Usage:

.delete()

• Parameters:

  . cSection: La Seccion en donde se buscara la clave a borrar.

  . cKey: La Clave que se busca borrar.

• Return Value: Si tuvo exito una Cadena de Caracteres con la clave y su valor, de lo contrario .null..

Example:

	loProfile = CREATEOBJECT('profile')
	IF loProfile.Read('config.ini') THEN
    	ASSERT !ISNULL(loProfile.Delete("Data Store", "BackEnd")) ;
        		MESSAGE "Atención, no se pudo eliminar la clave 'BackEnd'!"
	ENDIF

⬆ back to top

.getValue()

• Parameters:

  . cSection: Es la sección en donde se buscará la clave.

  . cKey: Es la clave a buscar.

• Return Value: Si existe, devuelve una cadena, de lo contrario .null..

Example:

	loProfile = CREATEOBJECT('profile')
	IF loProfile.Read('config.ini') THEN
		? loProfile.getValue('Data Store', 'BackEnd')
	ENDIF

⬆ back to top

.Read()

• Parameters:

  . cFileName: Es el Nombre del Archivo a Leer.

• Return Value: Si tuvo exito True, de lo contrario False.

Example:

	loProfile = CREATEOBJECT('profile')
	IF loProfile.Read('config.ini') THEN
		&&Archivo config.ini fue leido y cargado con exito.
	ENDIF

⬆ back to top

.Save()

• Parameters:

• Return Value: Si tuvo exito True, de lo contrario False.

Example:

	loProfile = CREATEOBJECT('profile')
	IF loProfile.Read('config.ini') THEN
		ASSERT loProfile.Save() ;
        		MESSAGE "Atención, no se pudo guardar el archivo"
	ENDIF

⬆ back to top

.SaveTo()

• Parameters:

  . cFileName: El nombre del nuevo archivo Profile.

• Return Value: Si tuvo exito True, de lo contrario False.

Example:

	loProfile = CREATEOBJECT('profile')
	IF loProfile.Read('config.ini') THEN
		ASSERT loProfile.SaveTo('nuevoarchivo.ini') ;
        		MESSAGE "Atención, no se pudo guardar en el nuevo archivo"
	ENDIF

⬆ back to top

.SetValue()

• Parameters:

  . cSection : Es la sección en donde se agrega la clave.

  . cKey : Es la clave.

  . eValue : El valor que se le cargarrá a la clave.

• Return Value: Si tuvo exito True, de lo contrario False

Example:

	loProfile = CREATEOBJECT('profile')
	IF loProfile.Read('config.ini') THEN
		ASSERT loProfile.setValue('Data Store', 'BackEnd', 'MySQL') ;
        		MESSAGE 'Error, no se pudo asignar el valor a la clave'
	ENDIF

⬆ back to top

Author

• Raúl Juárez - Initial work

http://rinconfox.com

License

/*
* ----------------------------------------------------------------------------------------
* "LA LICENCIA BEER-WARE" (Versión 42):
* <raul.jrz@gmail.com> escribió este archivo. Siempre y cuando usted mantenga este aviso,
* puede hacer lo que quiera con esta materia. Si nos encontramos algún día, y usted piensa
* que esto vale la pena, me puede comprar una cerveza a cambio. Raúl Juárez
* ----------------------------------------------------------------------------------------
*/

Do you like this project? Support it by donating

• Buy me a coffee
• Paypal: Si te sirvio, invitame un café o una cerveza
• Bitcoin:

⬆ back to top