Referencia del archivo config.h

#include <commons/config.h> Más...

Ir al código fuente de este archivo.

Estructuras de datos
struct	t_config
	Manejo de archivos de configuración. Inicializar con config_create(). Más...

Funciones
t_config *	config_create (char *path)
	Crea una estructura t_config.
bool	config_has_property (t_config *, char *key)
	Retorna true si key se encuentra en la configuracion.
char *	config_get_string_value (t_config *, char *key)
	Retorna un string con el valor asociado a key.
int	config_get_int_value (t_config *, char *key)
	Retorna un int con el valor asociado a key.
long	config_get_long_value (t_config *, char *key)
	Retorna un long con el valor asociado a key.
double	config_get_double_value (t_config *, char *key)
	Retorna un double con el valor asociado a key.
char **	config_get_array_value (t_config *, char *key)
	Retorna un array con los valores asociados a la key especificada.
int	config_keys_amount (t_config *)
	Retorna la cantidad de keys.
void	config_destroy (t_config *config)
	Destruye la estructura config.
void	config_set_value (t_config *, char *key, char *value)
	Setea el valor en el archivo de config, a la key asociada.
void	config_remove_key (t_config *, char *key)
	Remueve la clave y su valor asociado del archivo de config.
int	config_save (t_config *)
	Reescribe el archivo de configuracion con los valores del config.
int	config_save_in_file (t_config *, char *path)
	Escribe un archivo de configuracion en el path indicado con los valores del config.

Descripción detallada

#include <commons/config.h>

Documentación de funciones

config_create()

t_config * config_create

(

char *

path

)

Crea una estructura t_config.

Parámetros

path	Ruta hacia el archivo de configuracion

Devuelve

Retorna un puntero hacia la estructura creada, o NULL en caso de no encontrar el archivo en el path especificado. Una vez que se deje de usar, se debe liberar con config_destroy().

config_has_property()

bool config_has_property	(	t_config *	,
		char *	key
	)

Retorna true si key se encuentra en la configuracion.

config_get_string_value()

char * config_get_string_value	(	t_config *	,
		char *	key
	)

Retorna un string con el valor asociado a key.

Atención

Devuelve un puntero perteneciente a la estructura t_config, por lo que no debe ser liberado por fuera de la misma.

config_get_int_value()

int config_get_int_value	(	t_config *	,
		char *	key
	)

Retorna un int con el valor asociado a key.

config_get_long_value()

long config_get_long_value	(	t_config *	,
		char *	key
	)

Retorna un long con el valor asociado a key.

config_get_double_value()

double config_get_double_value	(	t_config *	,
		char *	key
	)

Retorna un double con el valor asociado a key.

config_get_array_value()

char ** config_get_array_value	(	t_config *	,
		char *	key
	)

Retorna un array con los valores asociados a la key especificada.

Devuelve

Devuelve un array de strings terminado en NULL. Debe ser liberado con string_array_destroy() una vez que se deje de usar.

Nota

En el archivo de configuracion un valor de este tipo debería ser representado de la siguiente forma [lista_valores_separados_por_coma]. Ejemplo:

VALORES=[1,2,3,4,5]

config_keys_amount()

int config_keys_amount

(

t_config *

)

Retorna la cantidad de keys.

config_destroy()

void config_destroy

(

t_config *

config

)

Destruye la estructura config.

config_set_value()

void config_set_value	(	t_config *	,
		char *	key,
		char *	value
	)

Setea el valor en el archivo de config, a la key asociada.

config_remove_key()

void config_remove_key	(	t_config *	,
		char *	key
	)

Remueve la clave y su valor asociado del archivo de config.

config_save()

int config_save

(

t_config *

)

Reescribe el archivo de configuracion con los valores del config.

Devuelve

Retorna mayor a 0 si se pudo guardar el archivo, -1 en caso de error.

config_save_in_file()

int config_save_in_file	(	t_config *	,
		char *	path
	)

Escribe un archivo de configuracion en el path indicado con los valores del config.

Devuelve

Retorna mayor a 0 si se pudo guardar el archivo, -1 en caso de error.