kc3-lang/libxml2/include/libxml/xmlwriter.h

Branch - branch -master- tag -v2.9.9-rc2v2.9.9-rc1v2.9.9v2.9.8-rc1v2.9.8v2.9.7-rc1v2.9.7v2.9.6-rc1v2.9.6v2.9.5-rc2v2.9.5-rc1v2.9.5v2.9.4-rc2v2.9.4-rc1v2.9.4v2.9.3v2.9.2-rc2v2.9.2-rc1v2.9.2v2.9.14v2.9.13v2.9.12v2.9.11v2.9.10-rc1v2.9.10v2.9.1v2.9.0-rc2v2.9.0v2.8.0-rc2v2.8.0-rc1v2.8.0v2.7.8v2.7.7v2.7.6v2.7.5v2.7.4v2.15.1v2.15.0v2.14.6v2.14.5v2.14.4v2.14.3v2.14.2v2.14.1v2.14.0v2.13.9v2.13.8v2.13.7v2.13.6v2.13.5v2.13.4v2.13.3v2.13.2v2.13.1v2.13.0v2.12.9v2.12.8v2.12.7v2.12.6v2.12.5v2.12.4v2.12.3v2.12.2v2.12.10v2.12.1v2.12.0v2.11.9v2.11.8v2.11.7v2.11.6v2.11.5v2.11.4v2.11.3v2.11.2v2.11.1v2.11.0v2.10.4v2.10.3v2.10.2v2.10.1v2.10.0helpPRE_MUCKUP3PRE_MUCKUP2PRE_MUCKUPLIB_XML_1_XLIB_XML_1_8_3LIB_XML_1_7_3LIB_XML_1_7_1LIB_XML_1_7_0LIB_XML_1_6_2LIB_XML_1_6_1LIB_XML_1_4LIB_XML_1_3LIB_XML_1_1LIBXML_TEST_2_0_0LIBXML_2_6_10LIBXML_2_5_6LIBXML_2_5_5LIBXML_2_5_4LIBXML_2_5_3LIBXML_2_5_2LIBXML_2_5_1LIBXML_2_4_7LIBXML_2_4_6LIBXML_2_4_4LIBXML_2_4_30LIBXML_2_4_3LIBXML_2_4_29LIBXML_2_4_27LIBXML_2_4_26LIBXML_2_4_25LIBXML_2_4_24LIBXML_2_4_23LIBXML_2_4_22LIBXML_2_4_20LIBXML_2_4_2LIBXML_2_4_18LIBXML_2_4_16LIBXML_2_4_14LIBXML_2_4_13LIBXML_2_4_12LIBXML_2_4_11LIBXML_2_4_0LIBXML_2_3_9LIBXML_2_3_8LIBXML_2_3_7LIBXML_2_3_6LIBXML_2_3_5LIBXML_2_3_4LIBXML_2_3_3LIBXML_2_3_2LIBXML_2_3_14LIBXML_2_3_13LIBXML_2_3_12LIBXML_2_3_11LIBXML_2_3_10LIBXML_2_3_0LIBXML_2_2_8LIBXML_2_2_7LIBXML_2_2_6LIBXML_2_2_4LIBXML_2_2_3LIBXML_2_2_1LIBXML_2_1_1LIBXML_2_1_0LIBXML_2_0_0LIBXML_1_8_9LIBXML_1_8_8LIBXML_1_8_6LIBXML_1_8_5LIBXML_1_8_17LIBXML_1_8_16LIBXML_1_8_14LIBXML_1_8_12LIBXML_1_8_10_REALLIBXML_1_8_10LIBXML_1_5_0LIBXML_0_99LIBXML2_6_0LIBXML2_2_6_9LIBXML2_2_6_8LIBXML2_2_6_7LIBXML2_2_6_6LIBXML2_2_6_5LIBXML2_2_6_4LIBXML2_2_6_3LIBXML2_2_6_28LIBXML2_2_6_27LIBXML2_2_6_26LIBXML2_2_6_24LIBXML2_2_6_23LIBXML2_2_6_22LIBXML2_2_6_21LIBXML2_2_6_20LIBXML2_2_6_2LIBXML2_2_6_19LIBXML2_2_6_18LIBXML2_2_6_16LIBXML2_2_6_15LIBXML2_2_6_14LIBXML2_2_6_13LIBXML2_2_6_12LIBXML2_2_6_11LIBXML2_2_6_1LIBXML2_2_5_xLIBXML2_2_5_9LIBXML2_2_5_8LIBXML2_2_5_7LIBXML2_2_5_11LIBXML2_2_5_10LIBXML2_2_5_0LIBXML2_2_4_21LIBXML2.7.3LIBXML2.7.2LIBXML2.7.1LIBXML2.7.0LIBXML2.6.32GNUMERIC_FIRST_PUBLIC_RELEASEGNOME_PRINT_0_24GNOME_0_30FOR_GNOME_0_99_1EAZEL-NAUTILUS-MS-AUG07ChangeLogCVE-2021-3541CVE-2016-4483CVE-2016-4449CVE-2016-3705CVE-2016-3627CVE-2016-1840CVE-2016-1839CVE-2016-1838CVE-2016-1837CVE-2016-1836CVE-2016-1835CVE-2016-1834CVE-2016-1833CVE-2016-1762CVE-2015-8317CVE-2015-8242CVE-2015-8035CVE-2015-7942-2CVE-2015-7942CVE-2015-7941_2CVE-2015-7941_1CVE-2015-7500CVE-2015-7499-2CVE-2015-7499-1CVE-2015-7498CVE-2015-7497CVE-2015-5312CVE-2015-1819CVE-2014-3660CVE-2014-0191CVE-2013-2877

• Show log

  Commit

• Hash : c7a9ef1d
  Author :
  Date : 2025-07-04T16:20:28
  

  doc: Document struct typedefs
  
  Unfortunately, Doxygen's TYPDEF_HIDES_STRUCT option is too broken.
  Document struct typedefs to make autolinks work.
  

Download

• include/libxml/xmlwriter.h

• /**
   * @file
   * 
   * @brief text writing API for XML
   * 
   * text writing API for XML
   *
   * @copyright See Copyright for the status of this software.
   *
   * @author Alfred Mickautsch
   */
  
  #ifndef __XML_XMLWRITER_H__
  #define __XML_XMLWRITER_H__
  
  #include <libxml/xmlversion.h>
  
  #ifdef LIBXML_WRITER_ENABLED
  
  #include <stdarg.h>
  #include <libxml/xmlIO.h>
  #include <libxml/list.h>
  #include <libxml/xmlstring.h>
  
  #ifdef __cplusplus
  extern "C" {
  #endif
  
      /** Writer object */
      typedef struct _xmlTextWriter xmlTextWriter;
      typedef xmlTextWriter *xmlTextWriterPtr;
  
  /*
   * Constructors & Destructor
   */
      XMLPUBFUN xmlTextWriter *
          xmlNewTextWriter(xmlOutputBuffer *out);
      XMLPUBFUN xmlTextWriter *
          xmlNewTextWriterFilename(const char *uri, int compression);
      XMLPUBFUN xmlTextWriter *
          xmlNewTextWriterMemory(xmlBuffer *buf, int compression);
      XMLPUBFUN xmlTextWriter *
          xmlNewTextWriterPushParser(xmlParserCtxt *ctxt, int compression);
      XMLPUBFUN xmlTextWriter *
          xmlNewTextWriterDoc(xmlDoc ** doc, int compression);
      XMLPUBFUN xmlTextWriter *
          xmlNewTextWriterTree(xmlDoc *doc, xmlNode *node,
                               int compression);
      XMLPUBFUN void xmlFreeTextWriter(xmlTextWriter *writer);
  
  /*
   * Functions
   */
  
  
  /*
   * Document
   */
      XMLPUBFUN int
          xmlTextWriterStartDocument(xmlTextWriter *writer,
                                     const char *version,
                                     const char *encoding,
                                     const char *standalone);
      XMLPUBFUN int xmlTextWriterEndDocument(xmlTextWriter *
                                                     writer);
  
  /*
   * Comments
   */
      XMLPUBFUN int xmlTextWriterStartComment(xmlTextWriter *
                                                      writer);
      XMLPUBFUN int xmlTextWriterEndComment(xmlTextWriter *writer);
      XMLPUBFUN int
          xmlTextWriterWriteFormatComment(xmlTextWriter *writer,
                                          const char *format, ...)
  					LIBXML_ATTR_FORMAT(2,3);
      XMLPUBFUN int
          xmlTextWriterWriteVFormatComment(xmlTextWriter *writer,
                                           const char *format,
                                           va_list argptr)
  					 LIBXML_ATTR_FORMAT(2,0);
      XMLPUBFUN int xmlTextWriterWriteComment(xmlTextWriter *
                                                      writer,
                                                      const xmlChar *
                                                      content);
  
  /*
   * Elements
   */
      XMLPUBFUN int
          xmlTextWriterStartElement(xmlTextWriter *writer,
                                    const xmlChar * name);
      XMLPUBFUN int xmlTextWriterStartElementNS(xmlTextWriter *
                                                        writer,
                                                        const xmlChar *
                                                        prefix,
                                                        const xmlChar * name,
                                                        const xmlChar *
                                                        namespaceURI);
      XMLPUBFUN int xmlTextWriterEndElement(xmlTextWriter *writer);
      XMLPUBFUN int xmlTextWriterFullEndElement(xmlTextWriter *
                                                        writer);
  
  /*
   * Elements conveniency functions
   */
      XMLPUBFUN int
          xmlTextWriterWriteFormatElement(xmlTextWriter *writer,
                                          const xmlChar * name,
                                          const char *format, ...)
  					LIBXML_ATTR_FORMAT(3,4);
      XMLPUBFUN int
          xmlTextWriterWriteVFormatElement(xmlTextWriter *writer,
                                           const xmlChar * name,
                                           const char *format,
                                           va_list argptr)
  					 LIBXML_ATTR_FORMAT(3,0);
      XMLPUBFUN int xmlTextWriterWriteElement(xmlTextWriter *
                                                      writer,
                                                      const xmlChar * name,
                                                      const xmlChar *
                                                      content);
      XMLPUBFUN int
          xmlTextWriterWriteFormatElementNS(xmlTextWriter *writer,
                                            const xmlChar * prefix,
                                            const xmlChar * name,
                                            const xmlChar * namespaceURI,
                                            const char *format, ...)
  					  LIBXML_ATTR_FORMAT(5,6);
      XMLPUBFUN int
          xmlTextWriterWriteVFormatElementNS(xmlTextWriter *writer,
                                             const xmlChar * prefix,
                                             const xmlChar * name,
                                             const xmlChar * namespaceURI,
                                             const char *format,
                                             va_list argptr)
  					   LIBXML_ATTR_FORMAT(5,0);
      XMLPUBFUN int xmlTextWriterWriteElementNS(xmlTextWriter *
                                                        writer,
                                                        const xmlChar *
                                                        prefix,
                                                        const xmlChar * name,
                                                        const xmlChar *
                                                        namespaceURI,
                                                        const xmlChar *
                                                        content);
  
  /*
   * Text
   */
      XMLPUBFUN int
          xmlTextWriterWriteFormatRaw(xmlTextWriter *writer,
                                      const char *format, ...)
  				    LIBXML_ATTR_FORMAT(2,3);
      XMLPUBFUN int
          xmlTextWriterWriteVFormatRaw(xmlTextWriter *writer,
                                       const char *format, va_list argptr)
  				     LIBXML_ATTR_FORMAT(2,0);
      XMLPUBFUN int
          xmlTextWriterWriteRawLen(xmlTextWriter *writer,
                                   const xmlChar * content, int len);
      XMLPUBFUN int
          xmlTextWriterWriteRaw(xmlTextWriter *writer,
                                const xmlChar * content);
      XMLPUBFUN int xmlTextWriterWriteFormatString(xmlTextWriter *
                                                           writer,
                                                           const char
                                                           *format, ...)
  							 LIBXML_ATTR_FORMAT(2,3);
      XMLPUBFUN int xmlTextWriterWriteVFormatString(xmlTextWriter *
                                                            writer,
                                                            const char
                                                            *format,
                                                            va_list argptr)
  							  LIBXML_ATTR_FORMAT(2,0);
      XMLPUBFUN int xmlTextWriterWriteString(xmlTextWriter *writer,
                                                     const xmlChar *
                                                     content);
      XMLPUBFUN int xmlTextWriterWriteBase64(xmlTextWriter *writer,
                                                     const char *data,
                                                     int start, int len);
      XMLPUBFUN int xmlTextWriterWriteBinHex(xmlTextWriter *writer,
                                                     const char *data,
                                                     int start, int len);
  
  /*
   * Attributes
   */
      XMLPUBFUN int
          xmlTextWriterStartAttribute(xmlTextWriter *writer,
                                      const xmlChar * name);
      XMLPUBFUN int xmlTextWriterStartAttributeNS(xmlTextWriter *
                                                          writer,
                                                          const xmlChar *
                                                          prefix,
                                                          const xmlChar *
                                                          name,
                                                          const xmlChar *
                                                          namespaceURI);
      XMLPUBFUN int xmlTextWriterEndAttribute(xmlTextWriter *
                                                      writer);
  
  /*
   * Attributes conveniency functions
   */
      XMLPUBFUN int
          xmlTextWriterWriteFormatAttribute(xmlTextWriter *writer,
                                            const xmlChar * name,
                                            const char *format, ...)
  					  LIBXML_ATTR_FORMAT(3,4);
      XMLPUBFUN int
          xmlTextWriterWriteVFormatAttribute(xmlTextWriter *writer,
                                             const xmlChar * name,
                                             const char *format,
                                             va_list argptr)
  					   LIBXML_ATTR_FORMAT(3,0);
      XMLPUBFUN int xmlTextWriterWriteAttribute(xmlTextWriter *
                                                        writer,
                                                        const xmlChar * name,
                                                        const xmlChar *
                                                        content);
      XMLPUBFUN int
          xmlTextWriterWriteFormatAttributeNS(xmlTextWriter *writer,
                                              const xmlChar * prefix,
                                              const xmlChar * name,
                                              const xmlChar * namespaceURI,
                                              const char *format, ...)
  					    LIBXML_ATTR_FORMAT(5,6);
      XMLPUBFUN int
          xmlTextWriterWriteVFormatAttributeNS(xmlTextWriter *writer,
                                               const xmlChar * prefix,
                                               const xmlChar * name,
                                               const xmlChar * namespaceURI,
                                               const char *format,
                                               va_list argptr)
  					     LIBXML_ATTR_FORMAT(5,0);
      XMLPUBFUN int xmlTextWriterWriteAttributeNS(xmlTextWriter *
                                                          writer,
                                                          const xmlChar *
                                                          prefix,
                                                          const xmlChar *
                                                          name,
                                                          const xmlChar *
                                                          namespaceURI,
                                                          const xmlChar *
                                                          content);
  
  /*
   * PI's
   */
      XMLPUBFUN int
          xmlTextWriterStartPI(xmlTextWriter *writer,
                               const xmlChar * target);
      XMLPUBFUN int xmlTextWriterEndPI(xmlTextWriter *writer);
  
  /*
   * PI conveniency functions
   */
      XMLPUBFUN int
          xmlTextWriterWriteFormatPI(xmlTextWriter *writer,
                                     const xmlChar * target,
                                     const char *format, ...)
  				   LIBXML_ATTR_FORMAT(3,4);
      XMLPUBFUN int
          xmlTextWriterWriteVFormatPI(xmlTextWriter *writer,
                                      const xmlChar * target,
                                      const char *format, va_list argptr)
  				    LIBXML_ATTR_FORMAT(3,0);
      XMLPUBFUN int
          xmlTextWriterWritePI(xmlTextWriter *writer,
                               const xmlChar * target,
                               const xmlChar * content);
  
  /**
   * This macro maps to #xmlTextWriterWritePI
   */
  #define xmlTextWriterWriteProcessingInstruction xmlTextWriterWritePI
  
  /*
   * CDATA
   */
      XMLPUBFUN int xmlTextWriterStartCDATA(xmlTextWriter *writer);
      XMLPUBFUN int xmlTextWriterEndCDATA(xmlTextWriter *writer);
  
  /*
   * CDATA conveniency functions
   */
      XMLPUBFUN int
          xmlTextWriterWriteFormatCDATA(xmlTextWriter *writer,
                                        const char *format, ...)
  				      LIBXML_ATTR_FORMAT(2,3);
      XMLPUBFUN int
          xmlTextWriterWriteVFormatCDATA(xmlTextWriter *writer,
                                         const char *format, va_list argptr)
  				       LIBXML_ATTR_FORMAT(2,0);
      XMLPUBFUN int
          xmlTextWriterWriteCDATA(xmlTextWriter *writer,
                                  const xmlChar * content);
  
  /*
   * DTD
   */
      XMLPUBFUN int
          xmlTextWriterStartDTD(xmlTextWriter *writer,
                                const xmlChar * name,
                                const xmlChar * pubid,
                                const xmlChar * sysid);
      XMLPUBFUN int xmlTextWriterEndDTD(xmlTextWriter *writer);
  
  /*
   * DTD conveniency functions
   */
      XMLPUBFUN int
          xmlTextWriterWriteFormatDTD(xmlTextWriter *writer,
                                      const xmlChar * name,
                                      const xmlChar * pubid,
                                      const xmlChar * sysid,
                                      const char *format, ...)
  				    LIBXML_ATTR_FORMAT(5,6);
      XMLPUBFUN int
          xmlTextWriterWriteVFormatDTD(xmlTextWriter *writer,
                                       const xmlChar * name,
                                       const xmlChar * pubid,
                                       const xmlChar * sysid,
                                       const char *format, va_list argptr)
  				     LIBXML_ATTR_FORMAT(5,0);
      XMLPUBFUN int
          xmlTextWriterWriteDTD(xmlTextWriter *writer,
                                const xmlChar * name,
                                const xmlChar * pubid,
                                const xmlChar * sysid,
                                const xmlChar * subset);
  
  /**
   * this macro maps to #xmlTextWriterWriteDTD
   */
  #define xmlTextWriterWriteDocType xmlTextWriterWriteDTD
  
  /*
   * DTD element definition
   */
      XMLPUBFUN int
          xmlTextWriterStartDTDElement(xmlTextWriter *writer,
                                       const xmlChar * name);
      XMLPUBFUN int xmlTextWriterEndDTDElement(xmlTextWriter *
                                                       writer);
  
  /*
   * DTD element definition conveniency functions
   */
      XMLPUBFUN int
          xmlTextWriterWriteFormatDTDElement(xmlTextWriter *writer,
                                             const xmlChar * name,
                                             const char *format, ...)
  					   LIBXML_ATTR_FORMAT(3,4);
      XMLPUBFUN int
          xmlTextWriterWriteVFormatDTDElement(xmlTextWriter *writer,
                                              const xmlChar * name,
                                              const char *format,
                                              va_list argptr)
  					    LIBXML_ATTR_FORMAT(3,0);
      XMLPUBFUN int xmlTextWriterWriteDTDElement(xmlTextWriter *
                                                         writer,
                                                         const xmlChar *
                                                         name,
                                                         const xmlChar *
                                                         content);
  
  /*
   * DTD attribute list definition
   */
      XMLPUBFUN int
          xmlTextWriterStartDTDAttlist(xmlTextWriter *writer,
                                       const xmlChar * name);
      XMLPUBFUN int xmlTextWriterEndDTDAttlist(xmlTextWriter *
                                                       writer);
  
  /*
   * DTD attribute list definition conveniency functions
   */
      XMLPUBFUN int
          xmlTextWriterWriteFormatDTDAttlist(xmlTextWriter *writer,
                                             const xmlChar * name,
                                             const char *format, ...)
  					   LIBXML_ATTR_FORMAT(3,4);
      XMLPUBFUN int
          xmlTextWriterWriteVFormatDTDAttlist(xmlTextWriter *writer,
                                              const xmlChar * name,
                                              const char *format,
                                              va_list argptr)
  					    LIBXML_ATTR_FORMAT(3,0);
      XMLPUBFUN int xmlTextWriterWriteDTDAttlist(xmlTextWriter *
                                                         writer,
                                                         const xmlChar *
                                                         name,
                                                         const xmlChar *
                                                         content);
  
  /*
   * DTD entity definition
   */
      XMLPUBFUN int
          xmlTextWriterStartDTDEntity(xmlTextWriter *writer,
                                      int pe, const xmlChar * name);
      XMLPUBFUN int xmlTextWriterEndDTDEntity(xmlTextWriter *
                                                      writer);
  
  /*
   * DTD entity definition conveniency functions
   */
      XMLPUBFUN int
          xmlTextWriterWriteFormatDTDInternalEntity(xmlTextWriter *writer,
                                                    int pe,
                                                    const xmlChar * name,
                                                    const char *format, ...)
  						  LIBXML_ATTR_FORMAT(4,5);
      XMLPUBFUN int
          xmlTextWriterWriteVFormatDTDInternalEntity(xmlTextWriter *writer,
                                                     int pe,
                                                     const xmlChar * name,
                                                     const char *format,
                                                     va_list argptr)
  						   LIBXML_ATTR_FORMAT(4,0);
      XMLPUBFUN int
          xmlTextWriterWriteDTDInternalEntity(xmlTextWriter *writer,
                                              int pe,
                                              const xmlChar * name,
                                              const xmlChar * content);
      XMLPUBFUN int
          xmlTextWriterWriteDTDExternalEntity(xmlTextWriter *writer,
                                              int pe,
                                              const xmlChar * name,
                                              const xmlChar * pubid,
                                              const xmlChar * sysid,
                                              const xmlChar * ndataid);
      XMLPUBFUN int
          xmlTextWriterWriteDTDExternalEntityContents(xmlTextWriter *
                                                      writer,
                                                      const xmlChar * pubid,
                                                      const xmlChar * sysid,
                                                      const xmlChar *
                                                      ndataid);
      XMLPUBFUN int xmlTextWriterWriteDTDEntity(xmlTextWriter *
                                                        writer, int pe,
                                                        const xmlChar * name,
                                                        const xmlChar *
                                                        pubid,
                                                        const xmlChar *
                                                        sysid,
                                                        const xmlChar *
                                                        ndataid,
                                                        const xmlChar *
                                                        content);
  
  /*
   * DTD notation definition
   */
      XMLPUBFUN int
          xmlTextWriterWriteDTDNotation(xmlTextWriter *writer,
                                        const xmlChar * name,
                                        const xmlChar * pubid,
                                        const xmlChar * sysid);
  
  /*
   * Indentation
   */
      XMLPUBFUN int
          xmlTextWriterSetIndent(xmlTextWriter *writer, int indent);
      XMLPUBFUN int
          xmlTextWriterSetIndentString(xmlTextWriter *writer,
                                       const xmlChar * str);
  
      XMLPUBFUN int
          xmlTextWriterSetQuoteChar(xmlTextWriter *writer, xmlChar quotechar);
  
  
  /*
   * misc
   */
      XMLPUBFUN int xmlTextWriterFlush(xmlTextWriter *writer);
      XMLPUBFUN int xmlTextWriterClose(xmlTextWriter *writer);
  
  #ifdef __cplusplus
  }
  #endif
  
  #endif /* LIBXML_WRITER_ENABLED */
  
  #endif                          /* __XML_XMLWRITER_H__ */
  

Download