Énumérations
enum	C_Inifile_error {   C_INIFILE_NO_ERROR, C_INIFILE_MODULE_INIT_ERR, C_INIFILE_MODULE_NO_INIT_ERR, C_INIFILE_OPEN_ERR,   C_INIFILE_READ_ERR, C_INIFILE_ARG_ERR, C_INIFILE_DYN_ALLOC_ERR, C_INIFILE_NO_SECTION_ERR,   C_INIFILE_NO_KEY_ERR, C_INIFILE_CONVERSION_ERR, NB_INIFILE_ERROR }
Fonctions
C_Bool	c_inifile_init (char const *const s_filename, C_Inifile_error *p_err)
void	c_inifile_close (void)
C_Bool	c_inifile_get_init (void)
char *	c_inifile_get_string (char const *const s_section, char const *const s_key, C_Inifile_error *p_err)
int	c_inifile_get_integer (char const *const s_section, char const *const s_key, C_Inifile_error *p_err)
unsigned int	c_inifile_get_uinteger (char const *const s_section, char const *const s_key, C_Inifile_error *p_err)
long	c_inifile_get_long (char const *const s_section, char const *const s_key, C_Inifile_error *p_err)
unsigned long	c_inifile_get_ulong (char const *const s_section, char const *const s_key, C_Inifile_error *p_err)
C_Bool	c_inifile_get_boolean (char const *const s_section, char const *const s_key, C_Inifile_error *p_err)
double	c_inifile_get_double (char const *const s_section, char const *const s_key, C_Inifile_error *p_err)
float	c_inifile_get_float (char const *const s_section, char const *const s_key, C_Inifile_error *p_err)
C_Bool	c_inifile_set_string (char const *const s_section, char const *const s_key, char const *const s_value, C_Inifile_error *p_err)
C_Bool	c_inifile_set_integer (char const *const s_section, char const *const s_key, const int i_value, C_Inifile_error *p_err)
C_Bool	c_inifile_set_uinteger (char const *const s_section, char const *const s_key, const int ui_value, C_Inifile_error *p_err)
C_Bool	c_inifile_set_long (char const *const s_section, char const *const s_key, const long l_value, C_Inifile_error *p_err)
C_Bool	c_inifile_set_ulong (char const *const s_section, char const *const s_key, const long ul_value, C_Inifile_error *p_err)
C_Bool	c_inifile_set_boolean (char const *const s_section, char const *const s_key, const C_Bool b_value, C_Inifile_error *p_err)
C_Bool	c_inifile_set_double (char const *const s_section, char const *const s_key, const double d_value, C_Inifile_error *p_err)
C_Bool	c_inifile_set_float (char const *const s_section, char const *const s_key, const float f_value, C_Inifile_error *p_err)
*C_Bool	c_inifile_delete (char const *const s_section, char const *const s_key, C_Inifile_error *p_err)

---

Documentation du type de l'énumération

enum C_Inifile_error

Constantes d'erreur de la bibliothèque C_IniFile.

Valeurs énumérées:

C_INIFILE_NO_ERROR	Pas d'erreurs.
C_INIFILE_MODULE_INIT_ERR	Module déjà initialisé.
C_INIFILE_MODULE_NO_INIT_ERR	Module non initialisé.
C_INIFILE_OPEN_ERR	Erreur d'ouverture du fichier.
C_INIFILE_READ_ERR	Erreur de lecture du fichier.
C_INIFILE_ARG_ERR	Arguments invalides ou non fournis.
C_INIFILE_DYN_ALLOC_ERR	Erreur d'allocation dynamique.
C_INIFILE_NO_SECTION_ERR	La section n'à pas été trouvée.
C_INIFILE_NO_KEY_ERR	La clé n'à pas été trouvée.
C_INIFILE_CONVERSION_ERR	Erreur durant la conversion de la donnée.
NB_INIFILE_ERROR

---

Documentation des fonctions

C_Bool c_inifile_init	(	char const *const	s_filename,
		C_Inifile_error *	p_err
	)

Initialise le module c_inifile.
Une seule initialisation est possible par processus.
Pour ouvrir un autre fichier de configuration par le biais du même processus, il faut fermee le module et le ré-ouvrir !

Paramètres:

	s_filename	Nom du fichier de configuration. Si le fichier n'existe pas, il est crée.
	p_err	Adresse d'une variable d'erreur de type: C_Inifile_error. L'argument peut être NULL.

Renvoie:

true si l'initialisation à réussie, sinon false.

En cas d'échec d'initialisation, si l'adresse d'une variable d'erreur à été fournie, la variable peut prendre l'une des valeurs suivantes:

• C_INIFILE_DYN_ALLOC_ERR
• C_INIFILE_MODULE_INIT_ERR
• C_INIFILE_ARG_ERR

void c_inifile_close

(

void

)

Ferme le module s'il est initialisé.

C_Bool c_inifile_get_init

(

void

)

Détermine si le module est initialisé ou non.

Renvoie:

true si le module est chargé, false sinon.

char* c_inifile_get_string	(	char const *const	s_section,
		char const *const	s_key,
		C_Inifile_error *	p_err
	)

Recherche une donnée de type: chaîne de caractères.
La chaîne retournée par la fonction doit être libérée avec free.

Paramètres:

	s_section	Section de la clé
	s_key	Nom de la clé
	p_err	Adresse d'une variable d'erreur de type: C_Inifile_error. L'argument peut être NULL mais il est conseillé d'en fournir une car c'est la seule façon de savoir si une erreur à été provoquée ou non.

Renvoie:

Chaîne de caractère avec un zero de fin.
NULL en cas d'erreurs.

En cas d'erreur, si l'adresse d'une variable d'erreur a ete fournie, la variable peut prendre l'une des valeurs suivantes:

• C_INIFILE_MODULE_NO_INIT_ERR
• C_INIFILE_ARG_ERR
• C_INIFILE_OPEN_ERR
• C_INIFILE_READ_ERR
• C_INIFILE_DYN_ALLOC_ERR
• C_INIFILE_NO_SECTION_ERR
• C_INIFILE_NO_KEY_ERR

int c_inifile_get_integer	(	char const *const	s_section,
		char const *const	s_key,
		C_Inifile_error *	p_err
	)

Recherche une donnée de type: entier (signed)..

Paramètres:

	s_section	Section de la clé
	s_key	Nom de la clé
	p_err	Adresse d'une variable d'erreur de type: C_Inifile_error. L'argument peut être NULL mais il est conseillé d'en fournir une car c'est la seule façon de savoir si une erreur à été provoquée ou non.

Renvoie:

Valeur de type int, signed int.

En cas d'erreur, si l'adresse d'une variable d'erreur a ete fournie, la variable peut prendre l'une des valeurs suivantes:

• C_INIFILE_MODULE_NO_INIT_ERR
• C_INIFILE_ARG_ERR
• C_INIFILE_OPEN_ERR
• C_INIFILE_READ_ERR
• C_INIFILE_DYN_ALLOC_ERR
• C_INIFILE_NO_SECTION_ERR
• C_INIFILE_NO_KEY_ERR
• C_INIFILE_CONVERSION_ERR

unsigned int c_inifile_get_uinteger	(	char const *const	s_section,
		char const *const	s_key,
		C_Inifile_error *	p_err
	)

Recherche une donnée de type: entier (unsigned)..

Paramètres:

	s_section	Section de la clé
	s_key	Nom de la clé
	p_err	Adresse d'une variable d'erreur de type: C_Inifile_error. L'argument peut être NULL mais il est conseillé d'en fournir une car c'est la seule façon de savoir si une erreur à été provoquée ou non.

Renvoie:

Valeur de type unsigned int.

En cas d'erreur, si l'adresse d'une variable d'erreur a ete fournie, la variable peut prendre l'une des valeurs suivantes:

• C_INIFILE_MODULE_NO_INIT_ERR
• C_INIFILE_ARG_ERR
• C_INIFILE_OPEN_ERR
• C_INIFILE_READ_ERR
• C_INIFILE_DYN_ALLOC_ERR
• C_INIFILE_NO_SECTION_ERR
• C_INIFILE_NO_KEY_ERR
• C_INIFILE_CONVERSION_ERR

long c_inifile_get_long	(	char const *const	s_section,
		char const *const	s_key,
		C_Inifile_error *	p_err
	)

Recherche une donnée de type: long (signed)..

Paramètres:

	s_section	Section de la clé
	s_key	Nom de la clé
	p_err	Adresse d'une variable d'erreur de type: C_Inifile_error. L'argument peut être NULL mais il est conseillé d'en fournir une car c'est la seule façon de savoir si une erreur à été provoquée ou non.

Renvoie:

Valeur de type long, signed long.

En cas d'erreur, si l'adresse d'une variable d'erreur a ete fournie, la variable peut prendre l'une des valeurs suivantes:

• C_INIFILE_MODULE_NO_INIT_ERR
• C_INIFILE_ARG_ERR
• C_INIFILE_OPEN_ERR
• C_INIFILE_READ_ERR
• C_INIFILE_DYN_ALLOC_ERR
• C_INIFILE_NO_SECTION_ERR
• C_INIFILE_NO_KEY_ERR
• C_INIFILE_CONVERSION_ERR

unsigned long c_inifile_get_ulong	(	char const *const	s_section,
		char const *const	s_key,
		C_Inifile_error *	p_err
	)

Recherche une donnée de type: long (unsigned).

Paramètres:

	s_section	Section de la clé
	s_key	Nom de la clé
	p_err	Adresse d'une variable d'erreur de type: C_Inifile_error. L'argument peut être NULL mais il est conseillé d'en fournir une car c'est la seule façon de savoir si une erreur à été provoquée ou non.

Renvoie:

Valeur de type unsigned long.

En cas d'erreur, si l'adresse d'une variable d'erreur a ete fournie, la variable peut prendre l'une des valeurs suivantes:

• C_INIFILE_MODULE_NO_INIT_ERR
• C_INIFILE_ARG_ERR
• C_INIFILE_OPEN_ERR
• C_INIFILE_READ_ERR
• C_INIFILE_DYN_ALLOC_ERR
• C_INIFILE_NO_SECTION_ERR
• C_INIFILE_NO_KEY_ERR
• C_INIFILE_CONVERSION_ERR

C_Bool c_inifile_get_boolean	(	char const *const	s_section,
		char const *const	s_key,
		C_Inifile_error *	p_err
	)

Recherche une donnée de type: entier (signed)..

Paramètres:

	s_section	Section de la clé
	s_key	Nom de la clé
	p_err	Adresse d'une variable d'erreur de type: C_Inifile_error. L'argument peut être NULL mais il est conseillé d'en fournir une car c'est la seule façon de savoir si une erreur à été provoquée ou non.

Renvoie:

Valeur de type C_Bool.

En cas d'erreur, si l'adresse d'une variable d'erreur a ete fournie, la variable peut prendre l'une des valeurs suivantes:

• C_INIFILE_MODULE_NO_INIT_ERR
• C_INIFILE_ARG_ERR
• C_INIFILE_OPEN_ERR
• C_INIFILE_READ_ERR
• C_INIFILE_DYN_ALLOC_ERR
• C_INIFILE_NO_SECTION_ERR
• C_INIFILE_NO_KEY_ERR
• C_INIFILE_CONVERSION_ERR

double c_inifile_get_double	(	char const *const	s_section,
		char const *const	s_key,
		C_Inifile_error *	p_err
	)

Recherche une donnée de type: double..

Paramètres:

	s_section	Section de la clé
	s_key	Nom de la clé
	p_err	Adresse d'une variable d'erreur de type: C_Inifile_error. L'argument peut être NULL mais il est conseillé d'en fournir une car c'est la seule façon de savoir si une erreur à été provoquée ou non.

Renvoie:

Valeur de type double.

En cas d'erreur, si l'adresse d'une variable d'erreur a ete fournie, la variable peut prendre l'une des valeurs suivantes:

• C_INIFILE_MODULE_NO_INIT_ERR
• C_INIFILE_ARG_ERR
• C_INIFILE_OPEN_ERR
• C_INIFILE_READ_ERR
• C_INIFILE_DYN_ALLOC_ERR
• C_INIFILE_NO_SECTION_ERR
• C_INIFILE_NO_KEY_ERR
• C_INIFILE_CONVERSION_ERR

float c_inifile_get_float	(	char const *const	s_section,
		char const *const	s_key,
		C_Inifile_error *	p_err
	)

Recherche une donnée de type: float..

Paramètres:

	s_section	Section de la clé
	s_key	Nom de la clé
	p_err	Adresse d'une variable d'erreur de type: C_Inifile_error. L'argument peut être NULL mais il est conseillé d'en fournir une car c'est la seule façon de savoir si une erreur à été provoquée ou non.

Renvoie:

Valeur de type float.

En cas d'erreur, si l'adresse d'une variable d'erreur a ete fournie, la variable peut prendre l'une des valeurs suivantes:

• C_INIFILE_MODULE_NO_INIT_ERR
• C_INIFILE_ARG_ERR
• C_INIFILE_OPEN_ERR
• C_INIFILE_READ_ERR
• C_INIFILE_DYN_ALLOC_ERR
• C_INIFILE_NO_SECTION_ERR
• C_INIFILE_NO_KEY_ERR
• C_INIFILE_CONVERSION_ERR

C_Bool c_inifile_set_string	(	char const *const	s_section,
		char const *const	s_key,
		char const *const	s_value,
		C_Inifile_error *	p_err
	)

Enregistrement d'une donnée de type: chaîne de caractères.

Paramètres:

	s_section	Nom de la section où enregistrer. Si la section n'existe pas elle est crée.
	s_key	Nom de la clé dans la section. Si la clé n'existe pas elle est crée sinon la veleur sera remplacée.
	s_value	Valeur à enregistrer.
	p_err	Adresse d'une variable d'erreur de type: C_Inifile_error. L'argument peut être NULL.

Renvoie:

true si l'enregistrement s'est effectué avec succés, sinon false

En cas d'erreur, si l'adresse d'une variable d'erreur à été fournie, la variable peut prendre l'une des valeurs suivantes:

• C_INIFILE_MODULE_NO_INIT_ERR
• C_INIFILE_ARG_ERR
• C_INIFILE_OPEN_ERR
• C_INIFILE_READ_ERR

C_Bool c_inifile_set_integer	(	char const *const	s_section,
		char const *const	s_key,
		const int	i_value,
		C_Inifile_error *	p_err
	)

Enregistrement d'une donnée de type: int, signed int.

Paramètres:

	s_section	Nom de la section où enregistrer. Si la section n'existe pas elle est crée.
	s_key	Nom de la clé dans la section. Si la clé n'existe pas elle est crée sinon la veleur sera remplacée.
	i_value	Valeur à enregistrer.
	p_err	Adresse d'une variable d'erreur de type: C_Inifile_error. L'argument peut être NULL.

Renvoie:

true si l'enregistrement s'est effectué avec succés, sinon false

En cas d'erreur, si l'adresse d'une variable d'erreur à été fournie, la variable peut prendre l'une des valeurs suivantes:

• C_INIFILE_MODULE_NO_INIT_ERR
• C_INIFILE_ARG_ERR
• C_INIFILE_OPEN_ERR
• C_INIFILE_READ_ERR

C_Bool c_inifile_set_uinteger	(	char const *const	s_section,
		char const *const	s_key,
		const int	ui_value,
		C_Inifile_error *	p_err
	)

Enregistrement d'une donnée de type: unsigned int.

Paramètres:

	s_section	Nom de la section où enregistrer. Si la section n'existe pas elle est crée.
	s_key	Nom de la clé dans la section. Si la clé n'existe pas elle est crée sinon la veleur sera remplacée.
	ui_value	Valeur à enregistrer.
	p_err	Adresse d'une variable d'erreur de type: C_Inifile_error. L'argument peut être NULL.

Renvoie:

true si l'enregistrement s'est effectué avec succés, sinon false

En cas d'erreur, si l'adresse d'une variable d'erreur à été fournie, la variable peut prendre l'une des valeurs suivantes:

• C_INIFILE_MODULE_NO_INIT_ERR
• C_INIFILE_ARG_ERR
• C_INIFILE_OPEN_ERR
• C_INIFILE_READ_ERR

C_Bool c_inifile_set_long	(	char const *const	s_section,
		char const *const	s_key,
		const long	l_value,
		C_Inifile_error *	p_err
	)

Enregistrement d'une donnée de type: long, signed long.

Paramètres:

	s_section	Nom de la section où enregistrer. Si la section n'existe pas elle est crée.
	s_key	Nom de la clé dans la section. Si la clé n'existe pas elle est crée sinon la veleur sera remplacée.
	l_value	Valeur à enregistrer.
	p_err	Adresse d'une variable d'erreur de type: C_Inifile_error. L'argument peut être NULL.

Renvoie:

true si l'enregistrement s'est effectué avec succés, sinon false

En cas d'erreur, si l'adresse d'une variable d'erreur à été fournie, la variable peut prendre l'une des valeurs suivantes:

• C_INIFILE_MODULE_NO_INIT_ERR
• C_INIFILE_ARG_ERR
• C_INIFILE_OPEN_ERR
• C_INIFILE_READ_ERR

C_Bool c_inifile_set_ulong	(	char const *const	s_section,
		char const *const	s_key,
		const long	ul_value,
		C_Inifile_error *	p_err
	)

Enregistrement d'une donnée de type: unsigned long.

Paramètres:

	s_section	Nom de la section où enregistrer. Si la section n'existe pas elle est crée.
	s_key	Nom de la clé dans la section. Si la clé n'existe pas elle est crée sinon la veleur sera remplacée.
	ul_value	Valeur à enregistrer.
	p_err	Adresse d'une variable d'erreur de type: C_Inifile_error. L'argument peut être NULL.

Renvoie:

true si l'enregistrement s'est effectué avec succés, sinon false

En cas d'erreur, si l'adresse d'une variable d'erreur à été fournie, la variable peut prendre l'une des valeurs suivantes:

• C_INIFILE_MODULE_NO_INIT_ERR
• C_INIFILE_ARG_ERR
• C_INIFILE_OPEN_ERR
• C_INIFILE_READ_ERR

C_Bool c_inifile_set_boolean	(	char const *const	s_section,
		char const *const	s_key,
		const C_Bool	b_value,
		C_Inifile_error *	p_err
	)

Enregistrement d'une donnée de type: C_Bool.

Paramètres:

	s_section	Nom de la section où enregistrer. Si la section n'existe pas elle est crée.
	s_key	Nom de la clé dans la section. Si la clé n'existe pas elle est crée sinon la veleur sera remplacée.
	b_value	Valeur à enregistrer.
	p_err	Adresse d'une variable d'erreur de type: C_Inifile_error. L'argument peut être NULL.

Renvoie:

true si l'enregistrement s'est effectué avec succés, sinon false

En cas d'erreur, si l'adresse d'une variable d'erreur à été fournie, la variable peut prendre l'une des valeurs suivantes:

• C_INIFILE_MODULE_NO_INIT_ERR
• C_INIFILE_ARG_ERR
• C_INIFILE_OPEN_ERR
• C_INIFILE_READ_ERR

C_Bool c_inifile_set_double	(	char const *const	s_section,
		char const *const	s_key,
		const double	d_value,
		C_Inifile_error *	p_err
	)

Enregistrement d'une donnée de type: double.

Paramètres:

	s_section	Nom de la section où enregistrer. Si la section n'existe pas elle est crée.
	s_key	Nom de la clé dans la section. Si la clé n'existe pas elle est crée sinon la veleur sera remplacée.
	d_value	Valeur à enregistrer.
	p_err	Adresse d'une variable d'erreur de type: C_Inifile_error. L'argument peut être NULL.

Renvoie:

true si l'enregistrement s'est effectué avec succés, sinon false

En cas d'erreur, si l'adresse d'une variable d'erreur à été fournie, la variable peut prendre l'une des valeurs suivantes:

• C_INIFILE_MODULE_NO_INIT_ERR
• C_INIFILE_ARG_ERR
• C_INIFILE_OPEN_ERR
• C_INIFILE_READ_ERR

C_Bool c_inifile_set_float	(	char const *const	s_section,
		char const *const	s_key,
		const float	f_value,
		C_Inifile_error *	p_err
	)

Enregistrement d'une donnée de type: float.

Paramètres:

	s_section	Nom de la section où enregistrer. Si la section n'existe pas elle est crée.
	s_key	Nom de la clé dans la section. Si la clé n'existe pas elle est crée sinon la veleur sera remplacée.
	f_value	Valeur à enregistrer.
	p_err	Adresse d'une variable d'erreur de type: C_Inifile_error. L'argument peut être NULL.

Renvoie:

true si l'enregistrement s'est effectué avec succés, sinon false

En cas d'erreur, si l'adresse d'une variable d'erreur à été fournie, la variable peut prendre l'une des valeurs suivantes:

• C_INIFILE_MODULE_NO_INIT_ERR
• C_INIFILE_ARG_ERR
• C_INIFILE_OPEN_ERR
• C_INIFILE_READ_ERR

* C_Bool c_inifile_delete	(	char const *const	s_section,
		char const *const	s_key,
		C_Inifile_error *	p_err
	)

Suppression d'une section ou d'une paire clé/valeur.

Paramètres:

	s_section	Nom de la section.
	s_key	Nom de la clé dans la section à supprimer. Si la clé n'est pas fournie, c'est la section entière qui est supprimée.
	p_err	Adresse d'une variable d'erreur de type: C_Inifile_error. L'argument peut etre NULL.

Renvoie:

true si la suppression a été effectuée avec succés, false sinon.

En cas d'erreur, si l'adresse d'une variable d'erreur à été fournie, la variable peut prendre l'une des valeurs suivantes:

• C_INIFILE_MODULE_NO_INIT_ERR
• C_INIFILE_ARG_ERR
• C_INIFILE_OPEN_ERR
• C_INIFILE_READ_ERR
• C_INIFILE_NO_SECTION_ERR
• C_INIFILE_NO_KEY_ERR

---