# GdaXmlDocument

## Name

GdaXmlDocument -- Base class for XML document management

## Synopsis

    GdaXmlDocument* gda_xml_document_new        (const gchar *root_doc);
    void        gda_xml_document_construct      (GdaXmlDocument *xmlfile,
                                                 const gchar *root_doc);
    gint        gda_xml_document_get_compress_mode
                                                (GdaXmlDocument *xmldoc);
    void        gda_xml_document_set_compress_mode
                                                (GdaXmlDocument *xmldoc,
                                                 gint mode);
    gboolean    gda_xml_document_to_file        (GdaXmlDocument *xmldoc,
                                                 const gchar *uri);
    gchar*      gda_xml_document_stringify      (GdaXmlDocument *xmldoc);

## Description

## Details

### gda_xml_document_new ()

    GdaXmlDocument* gda_xml_document_new        (const gchar *root_doc);

Create a new GdaXmlDocument object, with a root document of type `root_doc`

`root_doc` : | root document new
Returns : |

### gda_xml_document_construct ()

    void        gda_xml_document_construct      (GdaXmlDocument *xmlfile,
                                                 const gchar *root_doc);

`xmlfile` : |
`root_doc` : |

### gda_xml_document_get_compress_mode ()

    gint        gda_xml_document_get_compress_mode
                                                (GdaXmlDocument *xmldoc);

`xmldoc` : | a GdaXmlDocument object
Returns : | the compression mode being used by the given XML document

### gda_xml_document_set_compress_mode ()

    void        gda_xml_document_set_compress_mode
                                                (GdaXmlDocument *xmldoc,
                                                 gint mode);

`xmldoc` : |
`mode` : |

### gda_xml_document_to_file ()

    gboolean    gda_xml_document_to_file        (GdaXmlDocument *xmldoc,
                                                 const gchar *uri);

Saves the given GdaXmlDocument into a disk file. That is, it translates the in-memory document structure, transforms it to XML and saves, in the given file, the resulting XML output.

`xmldoc` : | a GdaXmlDocument object.
`uri` : | URI of the resulting file.
Returns : | TRUE if successful, FALSE on error.

### gda_xml_document_stringify ()

    gchar*      gda_xml_document_stringify      (GdaXmlDocument *xmldoc);

`xmldoc` : |
Returns : |