Documentation de la bibliothèque MLV-0.5

Définition de type | Fonctions

Référence du fichier MLV_xml.h

Ce fichier définit les prototypes des fonctions permettant de lire des fichier xml. Plus de détails...

Aller au code source de ce fichier.

Définition de type

typedef struct _MLV_Xml MLV_Xml
 Définit le type de donnée stockée au format xml dans la librairie MLV.

Fonctions

MLV_XmlMLV_load_xml (const char *xml_file_path)
 Charge en mémoire un fichier au format xml.
void MLV_free_xml (MLV_Xml *xml_data)
 Libère la mémoire utilisée par les donnees du fichier xml.
char * MLV_get_string_value_from_xml (MLV_Xml *xml_data, int i, const char *xpath,...)
 Permet d'accedr à l'interieur d'un champs donne du fichier xml.
char * MLV_get_string_value_from_xml_va (MLV_Xml *xml_data, int i, const char *xpath, va_list pile)
 Permet d'accedr à l'interieur d'un champs donne du fichier xml.
int MLV_get_integer_value_from_xml (MLV_Xml *xml_data, int i, const char *xpath,...)
 Permet de recupere l'entier d'un champs donne du fichier xml.
double MLV_get_double_value_from_xml (MLV_Xml *xml_data, int i, const char *xpath,...)
 Permet de recupere le reel d'un champs donne du fichier xml.
float MLV_get_float_value_from_xml (MLV_Xml *xml_data, int i, const char *xpath,...)
 Permet de recupere le réel d'un champs donne du fichier xml.
int MLV_get_number_of_objects_from_xml (MLV_Xml *xml_data, const char *xpath,...)
 Compte le nombre d'objet présent dans le fichier xml verifiant un certain nombre de critère passé en paramètre de la fonction.
MLV_XmlMLV_get_xml_object_of (MLV_Xml *xml_data,...)
 Permet d'acced à l'interieur d'un champs donne du fichier xml.
void MLV_print_xml (MLV_Xml *xml_data)
 écrit sur le terminal le contenu d'un fichier xml.

Description détaillée

Ce fichier définit les prototypes des fonctions permettant de lire des fichier xml.

Auteur:
Adrien Boussicault
Marc Zipstein

Les fichiers xml sont utiliés pour stocker les données nécessaire au fonctionnnement du programme. Ces fichiers permettent de modifier facilement l'execution du programme sans avoir à modifier le pogramme. En effet, ces sont lisible par l'homme et par la machine en même temps. Ils constituent donc une inteface pratique en entre ordinateur et utilisateur.


Documentation des fonctions

void MLV_free_xml ( MLV_Xml xml_data  ) 

Libère la mémoire utilisée par les donnees du fichier xml.

Paramètres:
xml_data les données xml a supprimer.
Exemples:
advanced/10_read_xml_file.c.
double MLV_get_double_value_from_xml ( MLV_Xml xml_data,
int  i,
const char *  xpath,
  ... 
)

Permet de recupere le reel d'un champs donne du fichier xml.

Paramètres:
xml_data les données xml.
i le ieme champs apparaissant dans le fichier et vérifiant le xpath
xpath Le chemin d'accesles parametres de la fonction.
Renvoie:
le reel extrait du xml
Exemples:
advanced/10_read_xml_file.c.
float MLV_get_float_value_from_xml ( MLV_Xml xml_data,
int  i,
const char *  xpath,
  ... 
)

Permet de recupere le réel d'un champs donne du fichier xml.

Paramètres:
xml_data les données xml.
i le ieme champs apparaissant dans le fichier et vérifiant le xpath
xpath Le chemin d'accesles parametres de la fonction.
Renvoie:
le reel extrait du xml
int MLV_get_integer_value_from_xml ( MLV_Xml xml_data,
int  i,
const char *  xpath,
  ... 
)

Permet de recupere l'entier d'un champs donne du fichier xml.

Paramètres:
xml_data les données xml.
i le ieme champs apparaissant dans le fichier et vérifiant le xpath
xpath Le chemin d'accesles parametres de la fonction.
Exemples:
advanced/10_read_xml_file.c.
int MLV_get_number_of_objects_from_xml ( MLV_Xml xml_data,
const char *  xpath,
  ... 
)

Compte le nombre d'objet présent dans le fichier xml verifiant un certain nombre de critère passé en paramètre de la fonction.

Paramètres:
xml_data les données xml.
xpath Le chemin d'accesles parametres de la fonction.
... les parametres de la fonction.
char* MLV_get_string_value_from_xml ( MLV_Xml xml_data,
int  i,
const char *  xpath,
  ... 
)

Permet d'accedr à l'interieur d'un champs donne du fichier xml.

Paramètres:
xml_data les données xml.
i le ieme champs apparaissant dans le fichier et vérifiant le xpath
xpath Le chemin d'accesles parametres de la fonction.
Exemples:
advanced/10_read_xml_file.c.
char* MLV_get_string_value_from_xml_va ( MLV_Xml xml_data,
int  i,
const char *  xpath,
va_list  pile 
)

Permet d'accedr à l'interieur d'un champs donne du fichier xml.

Paramètres:
xml_data les données xml.
i le ieme champs apparaissant dans le fichier et vérifiant le xpath
xpath Le chemin d'accesles parametres de la fonction.
pile La pile des complements de parametre comme dans vaprintf.
MLV_Xml* MLV_get_xml_object_of ( MLV_Xml xml_data,
  ... 
)

Permet d'acced à l'interieur d'un champs donne du fichier xml.

Paramètres:
xml_data les données xml.
... les parametres de la fonction.
MLV_Xml* MLV_load_xml ( const char *  xml_file_path  ) 

Charge en mémoire un fichier au format xml.

Cette fonction renvoi NULL, lorsque le fichier n'a pas pu être correctement chargé.

Paramètres:
xml_file_path Chemin d'accès du fichier xml.
Renvoie:
Le fichier xml lu, anamlysé et chargé.
Exemples:
advanced/10_read_xml_file.c.
void MLV_print_xml ( MLV_Xml xml_data  ) 

écrit sur le terminal le contenu d'un fichier xml.

Paramètres:
xml_data les données xml.
... les parametres de la fonction.