MLV_xml_va.h(3)

🦋 NAME 🦋

Hii bestie, meet MLV_xml_va.h — that's manual page section 3, the library functions manual, and it's lowkey iconic. ✨

So what is it? It's the header that defines the exact same function prototypes as MLV_xml.h... except every single one of them takes one extra argument: a list of type va_list. That's the whole plot twist. Same functions, but now they're vibing with a va_list in hand. 💅

---

✨ SYNOPSIS ✨

🎀 Fonctions 🎀

• MLV_Xml_error MLV_get_string_value_from_xml_va (const MLV_Xml *xml_data, char **result, const char *xpath, va_list pile) — lets you reach inside a given field of the xml file. 🫶
• MLV_Xml_error MLV_get_integer_value_from_xml_va (const MLV_Xml *xml_data, int *result, const char *xpath, va_list pile) — grabs the integer out of a given field of the xml file.
• MLV_Xml_error MLV_get_double_value_from_xml_va (const MLV_Xml *xml_data, double *result, const char *xpath, va_list pile) — grabs the double out of a given field of the xml file.
• MLV_Xml_error MLV_get_float_value_from_xml_va (const MLV_Xml *xml_data, float *result, const char *xpath, va_list pile) — grabs the float out of a given field of the xml file.
• int MLV_get_number_of_objects_from_xml_va (const MLV_Xml *xml_data, const char *xpath, va_list pile) — counts how many objects in the xml file match a bunch of criteria you pass as function parameters.
• MLV_Xml * MLV_get_xml_object_of_va (const MLV_Xml *xml_data, const char *xpath, va_list pile) — pulls out an internal node of the tree that represents the XML file.

---

💖 Description détaillée 💖

Okay so, for real: this file defines the same function prototypes as MLV_xml.h, just with an extra argument of type va_list tacked on. Same energy, one more parameter. 🌈

🌟 Auteur 🌟

• Adrien Boussicault
• Marc Zipstein

And here's the lore, bestie: xml files are used to store the data a program needs to actually run. They let you change how a program behaves without touching the program itself, which is so convenient. Why? Because they're readable by humans and by machines at the same time. They're literally a handy little interface between the computer and the user. 💜

---

📚 Documentation des fonctions 📚

🔥 MLV_Xml_error MLV_get_double_value_from_xml_va (const MLV_Xml * xml_data, double * result, const char * xpath, va_list pile)

This one grabs the double out of a given field of the xml file. Just like MLV_get_string_value_from_xml(), it can hold a variable number of parameters. Want the full tea? Go read the docs for MLV_get_string_value_from_xml(). 🍓

Paramètres

• xml_data — the xml data.
• result — a pointer to a double where the result of the function gets stored.
• xpath — the access path.
• pile — the stack of extra parameters, just like in vaprintf.

Renvoie

Returns an error code (see MLV_Xml_error) if the function didn't manage to extract the wanted data from the xml document. 😭

🔥 MLV_Xml_error MLV_get_float_value_from_xml_va (const MLV_Xml * xml_data, float * result, const char * xpath, va_list pile)

This one grabs the float out of a given field of the xml file. Same deal as MLV_get_string_value_from_xml() — it can hold a variable number of parameters. For more info, please read the documentation of MLV_get_string_value_from_xml(). 🧚

Paramètres

• xml_data — the xml data.
• result — a pointer to a float where the result of the function gets stored.
• xpath — the access path.
• pile — the stack of extra parameters, just like in vaprintf.

Renvoie

Returns an error code (see MLV_Xml_error) if the function didn't manage to extract the wanted data from the xml document. 💀

🔥 MLV_Xml_error MLV_get_integer_value_from_xml_va (const MLV_Xml * xml_data, int * result, const char * xpath, va_list pile)

This one grabs the integer out of a given field of the xml file. Yep, same as MLV_get_string_value_from_xml() — variable number of parameters, all that. For more info, please read the documentation of MLV_get_string_value_from_xml(). ✨

Paramètres

• xml_data — the xml data.
• result — a pointer to an integer where the result of the function gets stored.
• xpath — the access path.
• pile — the stack of extra parameters, just like in vaprintf.

Renvoie

Returns an error code if the function didn't manage to extract the wanted data from the xml document. 🙈

🔥 int MLV_get_number_of_objects_from_xml_va (const MLV_Xml * xml_data, const char * xpath, va_list pile)

Counts how many objects are in the xml file that match a certain number of criteria passed as parameters of the function. Counting queen behavior, honestly. 👑

Paramètres

• xml_data — the xml data.
• xpath — the access path.
• pile — the stack of extra parameters, just like in vaprintf.

Renvoie

This function returns the number of objects whose access path is 'xpath'. ⭐

🔥 MLV_Xml_error MLV_get_string_value_from_xml_va (const MLV_Xml * xml_data, char ** result, const char * xpath, va_list pile)

Lets you reach inside a given field of the xml file.

⚠️ Warning bestie, do NOT forget to free the memory associated with the result field. Not me being dramatic, it's literally in the docs. Free your memory. 🚨

Paramètres

• xml_data — the xml data.
• result — a pointer to an empty address that will hold the address of the character string corresponding to the result of the function.
• xpath — the access path.
• pile — the stack of extra parameters, just like in vaprintf.

Renvoie

Returns an error code if the function didn't manage to extract the wanted data from the xml document. 😭

🔥 MLV_Xml* MLV_get_xml_object_of_va (const MLV_Xml * xml_data, const char * xpath, va_list pile)

Pulls out an internal node of the tree that represents the XML file.

🚧 Heads up: this function is not implemented yet. It's giving "coming soon, stay tuned", not "coming soon, use it". Do not count on it. 💅

Paramètres

• xml_data — the xml data.
• xpath — the access path.
• pile — the stack of extra parameters, just like in vaprintf.

Renvoie

An internal node of the XML tree. 🌸

---

👑 Auteur 👑

Generated automatically by Doxygen for MLV-3.1.0 from the source code. Iconic of Doxygen to do all the talking. 🤖

---

Okay that's the whole page, bestie! This little love letter was auto-generated for MLV-3.1.0 and it's dated Samedi 29 Janvier 2022. Go forth and va_list responsibly. 💖🦋✨