Synopsis

struct xmlTextWriter

struct xmlTextWriter;

xmlTextWriterPtr

typedef xmlTextWriter *xmlTextWriterPtr;

xmlNewTextWriter ()

xmlTextWriterPtr xmlNewTextWriter           (xmlOutputBufferPtr out);

Create a new xmlNewTextWriter structure using an xmlOutputBufferPtr

xmlNewTextWriterFilename ()

xmlTextWriterPtr xmlNewTextWriterFilename   (const char *uri,
                                             int compression);

Create a new xmlNewTextWriter structure with uri as output

xmlNewTextWriterMemory ()

xmlTextWriterPtr xmlNewTextWriterMemory     (xmlBufferPtr buf,
                                             int compression);

Create a new xmlNewTextWriter structure with buf as output TODO: handle compression

xmlFreeTextWriter ()

void        xmlFreeTextWriter               (xmlTextWriterPtr writer);

Deallocate all the resources associated to the writer

xmlTextWriterStartDocument ()

int         xmlTextWriterStartDocument      (xmlTextWriterPtr writer,
                                             const char *version,
                                             const char *encoding,
                                             const char *standalone);

Start a new xml document

xmlTextWriterEndDocument ()

int         xmlTextWriterEndDocument        (xmlTextWriterPtr writer);

End an xml document. All open elements are closed

xmlTextWriterWriteFormatComment ()

int         xmlTextWriterWriteFormatComment (xmlTextWriterPtr writer,
                                             const char *format,
                                             ...);

Write an xml comment.

xmlTextWriterWriteVFormatComment ()

int         xmlTextWriterWriteVFormatComment
                                            (xmlTextWriterPtr writer,
                                             const char *format,
                                             va_list argptr);

Write an xml comment.

xmlTextWriterWriteComment ()

int         xmlTextWriterWriteComment       (xmlTextWriterPtr writer,
                                             const xmlChar *content);

Write an xml comment.

xmlTextWriterStartElement ()

int         xmlTextWriterStartElement       (xmlTextWriterPtr writer,
                                             const xmlChar *name);

Start an xml element.

xmlTextWriterStartElementNS ()

int         xmlTextWriterStartElementNS     (xmlTextWriterPtr writer,
                                             const xmlChar *prefix,
                                             const xmlChar *name,
                                             const xmlChar *namespaceURI);

Start an xml element with namespace support.

xmlTextWriterEndElement ()

int         xmlTextWriterEndElement         (xmlTextWriterPtr writer);

End the current xml element.

xmlTextWriterFullEndElement ()

int         xmlTextWriterFullEndElement     (xmlTextWriterPtr writer);

End the current xml element. Writes an end tag even if the element is empty

xmlTextWriterWriteFormatElement ()

int         xmlTextWriterWriteFormatElement (xmlTextWriterPtr writer,
                                             const xmlChar *name,
                                             const char *format,
                                             ...);

Write a formatted xml element.

xmlTextWriterWriteVFormatElement ()

int         xmlTextWriterWriteVFormatElement
                                            (xmlTextWriterPtr writer,
                                             const xmlChar *name,
                                             const char *format,
                                             va_list argptr);

Write a formatted xml element.

xmlTextWriterWriteElement ()

int         xmlTextWriterWriteElement       (xmlTextWriterPtr writer,
                                             const xmlChar *name,
                                             const xmlChar *content);

Write an xml element.

xmlTextWriterWriteFormatElementNS ()

int         xmlTextWriterWriteFormatElementNS
                                            (xmlTextWriterPtr writer,
                                             const xmlChar *prefix,
                                             const xmlChar *name,
                                             const xmlChar *namespaceURI,
                                             const char *format,
                                             ...);

Write a formatted xml element with namespace support.

xmlTextWriterWriteVFormatElementNS ()

int         xmlTextWriterWriteVFormatElementNS
                                            (xmlTextWriterPtr writer,
                                             const xmlChar *prefix,
                                             const xmlChar *name,
                                             const xmlChar *namespaceURI,
                                             const char *format,
                                             va_list argptr);

Write a formatted xml element with namespace support.

xmlTextWriterWriteElementNS ()

int         xmlTextWriterWriteElementNS     (xmlTextWriterPtr writer,
                                             const xmlChar *prefix,
                                             const xmlChar *name,
                                             const xmlChar *namespaceURI,
                                             const xmlChar *content);

Write an xml element with namespace support.

xmlTextWriterWriteFormatRaw ()

int         xmlTextWriterWriteFormatRaw     (xmlTextWriterPtr writer,
                                             const char *format,
                                             ...);

Write a formatted raw xml text.

xmlTextWriterWriteVFormatRaw ()

int         xmlTextWriterWriteVFormatRaw    (xmlTextWriterPtr writer,
                                             const char *format,
                                             va_list argptr);

Write a formatted raw xml text.

xmlTextWriterWriteRawLen ()

int         xmlTextWriterWriteRawLen        (xmlTextWriterPtr writer,
                                             const xmlChar *content,
                                             int len);

xmlTextWriterWriteRaw ()

int         xmlTextWriterWriteRaw           (xmlTextWriterPtr writer,
                                             const xmlChar *content);

Write a raw xml text.

xmlTextWriterWriteFormatString ()

int         xmlTextWriterWriteFormatString  (xmlTextWriterPtr writer,
                                             const char *format,
                                             ...);

Write a formatted xml text.

xmlTextWriterWriteVFormatString ()

int         xmlTextWriterWriteVFormatString (xmlTextWriterPtr writer,
                                             const char *format,
                                             va_list argptr);

Write a formatted xml text.

xmlTextWriterWriteString ()

int         xmlTextWriterWriteString        (xmlTextWriterPtr writer,
                                             const xmlChar *content);

Write an xml text.

xmlTextWriterWriteBase64 ()

int         xmlTextWriterWriteBase64        (xmlTextWriterPtr writer,
                                             const char *data,
                                             int start,
                                             int len);

Write an base64 encoded xml text.

xmlTextWriterWriteBinHex ()

int         xmlTextWriterWriteBinHex        (xmlTextWriterPtr writer,
                                             const char *data,
                                             int start,
                                             int len);

Write a BinHex encoded xml text.

xmlTextWriterStartAttribute ()

int         xmlTextWriterStartAttribute     (xmlTextWriterPtr writer,
                                             const xmlChar *name);

Start an xml attribute.

xmlTextWriterStartAttributeNS ()

int         xmlTextWriterStartAttributeNS   (xmlTextWriterPtr writer,
                                             const xmlChar *prefix,
                                             const xmlChar *name,
                                             const xmlChar *namespaceURI);

Start an xml attribute with namespace support.

xmlTextWriterEndAttribute ()

int         xmlTextWriterEndAttribute       (xmlTextWriterPtr writer);

End the current xml element.

xmlTextWriterWriteFormatAttribute ()

int         xmlTextWriterWriteFormatAttribute
                                            (xmlTextWriterPtr writer,
                                             const xmlChar *name,
                                             const char *format,
                                             ...);

Write a formatted xml attribute.

xmlTextWriterWriteVFormatAttribute ()

int         xmlTextWriterWriteVFormatAttribute
                                            (xmlTextWriterPtr writer,
                                             const xmlChar *name,
                                             const char *format,
                                             va_list argptr);

Write a formatted xml attribute.

xmlTextWriterWriteAttribute ()

int         xmlTextWriterWriteAttribute     (xmlTextWriterPtr writer,
                                             const xmlChar *name,
                                             const xmlChar *content);

Write an xml attribute.

xmlTextWriterWriteFormatAttributeNS ()

int         xmlTextWriterWriteFormatAttributeNS
                                            (xmlTextWriterPtr writer,
                                             const xmlChar *prefix,
                                             const xmlChar *name,
                                             const xmlChar *namespaceURI,
                                             const char *format,
                                             ...);

Write a formatted xml attribute.with namespace support

xmlTextWriterWriteVFormatAttributeNS ()

int         xmlTextWriterWriteVFormatAttributeNS
                                            (xmlTextWriterPtr writer,
                                             const xmlChar *prefix,
                                             const xmlChar *name,
                                             const xmlChar *namespaceURI,
                                             const char *format,
                                             va_list argptr);

Write a formatted xml attribute.with namespace support

xmlTextWriterWriteAttributeNS ()

int         xmlTextWriterWriteAttributeNS   (xmlTextWriterPtr writer,
                                             const xmlChar *prefix,
                                             const xmlChar *name,
                                             const xmlChar *namespaceURI,
                                             const xmlChar *content);

Write an xml attribute.

xmlTextWriterStartPI ()

int         xmlTextWriterStartPI            (xmlTextWriterPtr writer,
                                             const xmlChar *target);

Start an xml PI.

xmlTextWriterEndPI ()

int         xmlTextWriterEndPI              (xmlTextWriterPtr writer);

End the current xml PI.

xmlTextWriterWriteFormatPI ()

int         xmlTextWriterWriteFormatPI      (xmlTextWriterPtr writer,
                                             const xmlChar *target,
                                             const char *format,
                                             ...);

Write a formatted PI.

xmlTextWriterWriteVFormatPI ()

int         xmlTextWriterWriteVFormatPI     (xmlTextWriterPtr writer,
                                             const xmlChar *target,
                                             const char *format,
                                             va_list argptr);

Write a formatted xml PI.

xmlTextWriterWritePI ()

int         xmlTextWriterWritePI            (xmlTextWriterPtr writer,
                                             const xmlChar *target,
                                             const xmlChar *content);

Write an xml PI.

xmlTextWriterWriteProcessingInstruction

#define xmlTextWriterWriteProcessingInstruction xmlTextWriterWritePI

xmlTextWriterStartCDATA ()

int         xmlTextWriterStartCDATA         (xmlTextWriterPtr writer);

Start an xml CDATA section.

xmlTextWriterEndCDATA ()

int         xmlTextWriterEndCDATA           (xmlTextWriterPtr writer);

End an xml CDATA section.

xmlTextWriterWriteFormatCDATA ()

int         xmlTextWriterWriteFormatCDATA   (xmlTextWriterPtr writer,
                                             const char *format,
                                             ...);

Write a formatted xml CDATA.

xmlTextWriterWriteVFormatCDATA ()

int         xmlTextWriterWriteVFormatCDATA  (xmlTextWriterPtr writer,
                                             const char *format,
                                             va_list argptr);

Write a formatted xml CDATA.

xmlTextWriterWriteCDATA ()

int         xmlTextWriterWriteCDATA         (xmlTextWriterPtr writer,
                                             const xmlChar *content);

Write an xml CDATA.

xmlTextWriterStartDTD ()

int         xmlTextWriterStartDTD           (xmlTextWriterPtr writer,
                                             const xmlChar *name,
                                             const xmlChar *pubid,
                                             const xmlChar *sysid);

Start an xml DTD.

xmlTextWriterEndDTD ()

int         xmlTextWriterEndDTD             (xmlTextWriterPtr writer);

End an xml DTD.

xmlTextWriterWriteFormatDTD ()

int         xmlTextWriterWriteFormatDTD     (xmlTextWriterPtr writer,
                                             const xmlChar *name,
                                             const xmlChar *pubid,
                                             const xmlChar *sysid,
                                             const char *format,
                                             ...);

Write a DTD with a formatted markup declarations part.

xmlTextWriterWriteVFormatDTD ()

int         xmlTextWriterWriteVFormatDTD    (xmlTextWriterPtr writer,
                                             const xmlChar *name,
                                             const xmlChar *pubid,
                                             const xmlChar *sysid,
                                             const char *format,
                                             va_list argptr);

Write a DTD with a formatted markup declarations part.

xmlTextWriterWriteDTD ()

int         xmlTextWriterWriteDTD           (xmlTextWriterPtr writer,
                                             const xmlChar *name,
                                             const xmlChar *pubid,
                                             const xmlChar *sysid,
                                             const xmlChar *subset);

Write a DTD.

xmlTextWriterWriteDocType

#define xmlTextWriterWriteDocType xmlTextWriterWriteDTD

xmlTextWriterStartDTDElement ()

int         xmlTextWriterStartDTDElement    (xmlTextWriterPtr writer,
                                             const xmlChar *name);

xmlTextWriterEndDTDElement

#define xmlTextWriterEndDTDElement xmlTextWriterEndDTD

xmlTextWriterWriteFormatDTDElement ()

int         xmlTextWriterWriteFormatDTDElement
                                            (xmlTextWriterPtr writer,
                                             const xmlChar *name,
                                             const char *format,
                                             ...);

xmlTextWriterWriteVFormatDTDElement ()

int         xmlTextWriterWriteVFormatDTDElement
                                            (xmlTextWriterPtr writer,
                                             const xmlChar *name,
                                             const char *format,
                                             va_list argptr);

xmlTextWriterWriteDTDElement ()

int         xmlTextWriterWriteDTDElement    (xmlTextWriterPtr writer,
                                             const xmlChar *name,
                                             const xmlChar *content);

xmlTextWriterStartDTDAttlist ()

int         xmlTextWriterStartDTDAttlist    (xmlTextWriterPtr writer,
                                             const xmlChar *name);

xmlTextWriterEndDTDAttlist

#define xmlTextWriterEndDTDAttlist xmlTextWriterEndDTD

xmlTextWriterWriteFormatDTDAttlist ()

int         xmlTextWriterWriteFormatDTDAttlist
                                            (xmlTextWriterPtr writer,
                                             const xmlChar *name,
                                             const char *format,
                                             ...);

xmlTextWriterWriteVFormatDTDAttlist ()

int         xmlTextWriterWriteVFormatDTDAttlist
                                            (xmlTextWriterPtr writer,
                                             const xmlChar *name,
                                             const char *format,
                                             va_list argptr);

xmlTextWriterWriteDTDAttlist ()

int         xmlTextWriterWriteDTDAttlist    (xmlTextWriterPtr writer,
                                             const xmlChar *name,
                                             const xmlChar *content);

xmlTextWriterStartDTDEntity ()

int         xmlTextWriterStartDTDEntity     (xmlTextWriterPtr writer,
                                             int pe,
                                             const xmlChar *name);

xmlTextWriterEndDTDEntity

#define xmlTextWriterEndDTDEntity xmlTextWriterEndDTD

xmlTextWriterWriteFormatDTDInternalEntity ()

int         xmlTextWriterWriteFormatDTDInternalEntity
                                            (xmlTextWriterPtr writer,
                                             int pe,
                                             const xmlChar *name,
                                             const char *format,
                                             ...);

xmlTextWriterWriteVFormatDTDInternalEntity ()

int         xmlTextWriterWriteVFormatDTDInternalEntity
                                            (xmlTextWriterPtr writer,
                                             int pe,
                                             const xmlChar *name,
                                             const char *format,
                                             va_list argptr);

xmlTextWriterWriteDTDInternalEntity ()

int         xmlTextWriterWriteDTDInternalEntity
                                            (xmlTextWriterPtr writer,
                                             int pe,
                                             const xmlChar *name,
                                             const xmlChar *content);

xmlTextWriterWriteDTDExternalEntity ()

int         xmlTextWriterWriteDTDExternalEntity
                                            (xmlTextWriterPtr writer,
                                             int pe,
                                             const xmlChar *name,
                                             const xmlChar *pubid,
                                             const xmlChar *sysid,
                                             const xmlChar *ndataid);

xmlTextWriterWriteDTDEntity ()

int         xmlTextWriterWriteDTDEntity     (xmlTextWriterPtr writer,
                                             int pe,
                                             const xmlChar *name,
                                             const xmlChar *pubid,
                                             const xmlChar *sysid,
                                             const xmlChar *ndataid,
                                             const xmlChar *content);

xmlTextWriterWriteDTDNotation ()

int         xmlTextWriterWriteDTDNotation   (xmlTextWriterPtr writer,
                                             const xmlChar *name,
                                             const xmlChar *pubid,
                                             const xmlChar *sysid);

xmlTextWriterFlush ()

int         xmlTextWriterFlush              (xmlTextWriterPtr writer);

Flush the output buffer.