Documentation of the MLV-0.6.713 library

/*
 *   This file is part of the MLV Library.
 *
 *   Copyright (C) 2010,2011,2012 Adrien Boussicault, Marc Zipstein
 *
 *
 *    This Library is free software: you can redistribute it and/or modify
 *    it under the terms of the GNU General Public License as published by
 *    the Free Software Foundation, either version 3 of the License, or
 *    (at your option) any later version.
 *
 *    This Library is distributed in the hope that it will be useful,
 *    but WITHOUT ANY WARRANTY; without even the implied warranty of
 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *    GNU General Public License for more details.
 *
 *    You should have received a copy of the GNU General Public License
 *    along with this Library.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef __MLV__MLV_XML_H__
#define __MLV__MLV_XML_H__

#include <stdarg.h>

#ifdef __cplusplus
extern "C" {
#endif

typedef struct _MLV_Xml MLV_Xml;

MLV_Xml* MLV_load_xml( const char* xml_file_path );

void MLV_free_xml( MLV_Xml* xml_data );

typedef enum {
        MLV_XML_NONE, 
        MLV_XML_THE_FIELD_DOESNT_EXIST, 
        MLV_XML_THE_FIELD_IS_NOT_A_REAL, 
        MLV_XML_THE_FIELD_IS_NOT_AN_INTEGER, 
        MLV_XML_THE_FIELD_IS_TOO_BIG 
} MLV_Xml_error;

MLV_Xml_error MLV_get_string_value_from_xml(
        const MLV_Xml* xml_data, char** result , const char* xpath, ...
);

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


MLV_Xml_error MLV_get_integer_value_from_xml(
        const MLV_Xml* xml_data, int* result, const char* xpath, ...
);

MLV_Xml_error MLV_get_double_value_from_xml(
        const MLV_Xml* xml_data, double* result, const char* xpath, ...
);

MLV_Xml_error MLV_get_float_value_from_xml(
        const MLV_Xml* xml_data, float* result, const char* xpath, ...
);


int MLV_get_number_of_objects_from_xml(
        const MLV_Xml* xml_data, const char* xpath, ...
);

MLV_Xml* MLV_get_xml_object_of( const MLV_Xml* xml_data, const char* xpath, ... );

void MLV_print_xml( const MLV_Xml* xml_data );

#ifdef __cplusplus
}
#endif

#endif