The examples are stored per section depending on the main focus of the example:

• XPath :

  • xpath1.c: Evaluate XPath expression and prints result node set.

• xmlWriter :

  • testWriter.c: use various APIs for the xmlWriter

• Parsing :

  • parse1.c: Parse an XML file to a tree and free it
  • parse2.c: Parse and validate an XML file to a tree and free the result

• Tree :

  • tree1.c: Navigates a tree to print element names
  • tree2.c: Creates a tree

• xmlReader :

  • reader1.c: Parse an XML file with an xmlReader
  • reader2.c: Parse and validate an XML file with an xmlReader
  • reader3.c: Show how to extract subdocuments with xmlReader

Parsing Examples

parse1.c: Parse an XML file to a tree and free it

Demonstrate the use of xmlReadFile() to read an XML file into a tree and and xmlFreeDoc() to free the resulting tree

Includes:

• <libxml/tree.h>
• <libxml/parser.h>

Uses:

• line 24: Type xmlDocPtr from tree.h
• line 26: Function xmlReadFile from parser.h
• line 31: Function xmlFreeDoc from tree.h
• line 45: Macro LIBXML_TEST_VERSION from xmlversion.h
• line 50: Function xmlCleanupParser from parser.h

Usage:

parse1 test1.xml

Author: Daniel Veillard

parse2.c: Parse and validate an XML file to a tree and free the result

Create a parser context for an XML file, then parse and validate the file, creating a tree, check the validation result and xmlFreeDoc() to free the resulting tree.

Includes:

• <libxml/tree.h>
• <libxml/parser.h>

Uses:

• line 25: Type xmlParserCtxtPtr from tree.h
• line 26: Type xmlDocPtr from tree.h
• line 29: Function xmlNewParserCtxt from parser.h
• line 35: Function xmlCtxtReadFile from parser.h
• line 44: Function xmlFreeDoc from tree.h
• line 47: Function xmlFreeParserCtxt from parser.h
• line 61: Macro LIBXML_TEST_VERSION from xmlversion.h
• line 66: Function xmlCleanupParser from parser.h

Usage:

parse2 test2.xml

Author: Daniel Veillard

Tree Examples

tree1.c: Navigates a tree to print element names

Parse a file to a tree, use xmlDocGetRootElement() to get the root element, then walk the document and print all the element name in document order.

Includes:

• <libxml/tree.h>
• <libxml/parser.h>

Uses:

• line 65: Macro LIBXML_TEST_VERSION from xmlversion.h
• line 65: Function xmlParseFile from parser.h
• line 72: Function xmlDocGetRootElement from tree.h
• line 77: Function xmlFreeDoc from tree.h
• line 83: Function xmlCleanupParser from parser.h

Usage:

tree1 filename_or_URL

Author: Dodji Seketeli

tree2.c: Creates a tree

Shows how to create document, nodes and dump it to stdout or file.

Includes:

• <libxml/tree.h>
• <libxml/parser.h>

Uses:

• line 32: Macro LIBXML_TEST_VERSION from xmlversion.h
• line 37: Function xmlNewDoc from tree.h
• line 39: Function xmlDocSetRootElement from tree.h
• line 44: Function xmlCreateIntSubset from tree.h
• line 72: Function xmlNewNode from tree.h
• line 73: Function xmlNewText from tree.h
• line 76: Function xmlAddChild from tree.h
• line 86: Function xmlNewChild from tree.h
• line 87: Function xmlNewProp from tree.h
• line 94: Function xmlSaveFormatFileEnc from tree.h
• line 97: Function xmlFreeDoc from tree.h
• line 103: Function xmlCleanupParser from parser.h

Usage:

tree2 <filename> -Default output: stdout

Author: Lucas Brasilino <brasilino@recife.pe.gov.br>

XPath Examples

xpath1.c: Evaluate XPath expression and prints result node set.

Shows how to evaluate XPath expression and register known namespaces in XPath context.

Includes:

• <libxml/xpath.h>
• <libxml/parser.h>
• <libxml/xpathInternals.h>
• <libxml/tree.h>

Uses:

• line 35: Function xmlInitParser from parser.h
• line 39: Macro LIBXML_TEST_VERSION from xmlversion.h
• line 45: Function xmlCleanupParser from parser.h
• line 78: Type xmlDocPtr from tree.h
• line 79: Type xmlXPathContextPtr from xpath.h
• line 80: Type xmlXPathObjectPtr from xpath.h
• line 86: Function xmlParseFile from parser.h
• line 93: Function xmlXPathNewContext from xpath.h
• line 109: Function xmlXPathEvalExpression from xpath.h
• line 121: Function xmlXPathFreeObject from xpath.h
• line 122: Function xmlXPathFreeContext from xpath.h
• line 123: Function xmlFreeDoc from tree.h
• line 148: Function xmlStrdup from parser.h
• line 172: Function xmlStrchr from parser.h
• line 178: Function xmlXPathRegisterNs from xpathInternals.h
• line 198: Type xmlNodePtr from tree.h
• line 210: Type xmlNsPtr from tree.h

Usage:

xpath1 <xml-file> <xpath-expr> [<known-ns-list>]

Author: Aleksey Sanin

xmlReader Examples

reader1.c: Parse an XML file with an xmlReader

Demonstrate the use of xmlReaderForFile() to parse an XML file and dump the informations about the nodes found in the process

Includes:

• <libxml/xmlreader.h>

Uses:

• line 25: Function xmlTextReaderConstName from xmlreader.h
• line 29: Function xmlTextReaderConstValue from xmlreader.h
• line 32: Function xmlTextReaderDepth from xmlreader.h
• line 33: Function xmlTextReaderNodeType from xmlreader.h
• line 35: Function xmlTextReaderIsEmptyElement from xmlreader.h
• line 36: Function xmlTextReaderHasValue from xmlreader.h
• line 40: Function xmlStrlen from parser.h
• line 55: Type xmlTextReaderPtr from xmlreader.h
• line 58: Function xmlReaderForFile from xmlreader.h
• line 63: Function xmlTextReaderRead from xmlreader.h
• line 65: Function xmlFreeTextReader from xmlreader.h
• line 85: Macro LIBXML_TEST_VERSION from xmlversion.h
• line 90: Function xmlCleanupParser from parser.h

Usage:

reader1 <filename>

Author: Daniel Veillard

reader2.c: Parse and validate an XML file with an xmlReader

Demonstrate the use of xmlReaderForFile() to parse an XML file validating the content in the process and activating options like entities substitution, and DTD attributes defaulting

Includes:

• <libxml/xmlreader.h>

Uses:

• line 26: Function xmlTextReaderConstName from xmlreader.h
• line 30: Function xmlTextReaderConstValue from xmlreader.h
• line 33: Function xmlTextReaderDepth from xmlreader.h
• line 34: Function xmlTextReaderNodeType from xmlreader.h
• line 36: Function xmlTextReaderIsEmptyElement from xmlreader.h
• line 37: Function xmlTextReaderHasValue from xmlreader.h
• line 41: Function xmlStrlen from parser.h
• line 56: Type xmlTextReaderPtr from xmlreader.h
• line 64: Function xmlReaderForFile from xmlreader.h
• line 72: Function xmlTextReaderRead from xmlreader.h
• line 77: Function xmlTextReaderIsValid from xmlreader.h
• line 80: Function xmlFreeTextReader from xmlreader.h

Usage:

reader2 <valid_xml_filename>

Author: Daniel Veillard

reader3.c: Show how to extract subdocuments with xmlReader

Demonstrate the use of xmlTextReaderPreservePattern() to parse an XML file with the xmlReader while collecting only some subparts of the document

Includes:

• <libxml/xmlreader.h>

Uses:

• line 27: Type xmlTextReaderPtr from xmlreader.h
• line 33: Function xmlReaderForFile from xmlreader.h
• line 38: Function xmlTextReaderPreservePattern from xmlreader.h
• line 47: Function xmlTextReaderRead from xmlreader.h
• line 57: Function xmlTextReaderCurrentDoc from xmlreader.h
• line 61: Function xmlFreeTextReader from xmlreader.h
• line 72: Type xmlDocPtr from tree.h
• line 91: Function xmlDocDump from tree.h

Usage:

reader3

Author: Daniel Veillard

xmlWriter Examples

testWriter.c: use various APIs for the xmlWriter

tests a number of APIs for the xmlWriter, especially the various methods to write to a filename, to a memory buffer, to a new document, or to a subtree. It shows how to do encoding string conversions too. The resulting documents are then serialized.

Includes:

• <libxml/encoding.h>
• <libxml/xmlwriter.h>

Uses:

• line 58: Function xmlNewTextWriterFilename from xmlwriter.h
• line 320: Type xmlBufferPtr from tree.h
• line 325: Function xmlBufferCreate from tree.h
• line 333: Function xmlNewTextWriterMemory from xmlwriter.h
• line 603: Function xmlNewTextWriterDoc from xmlwriter.h
• line 846: Type xmlTextWriterPtr from xmlwriter.h
• line 847: Type xmlDocPtr from tree.h
• line 848: Type xmlNodePtr from tree.h
• line 852: Macro XML_DEFAULT_VERSION from parser.h
• line 852: Function xmlNewDoc from tree.h
• line 861: Function xmlNewDocNode from tree.h
• line 868: Function xmlDocSetRootElement from tree.h
• line 871: Function xmlNewTextWriterTree from xmlwriter.h
• line 880: Function xmlTextWriterStartDocument from xmlwriter.h
• line 890: Function xmlTextWriterWriteComment from xmlwriter.h
• line 916: Function xmlTextWriterWriteAttribute from xmlwriter.h
• line 925: Function xmlTextWriterWriteFormatComment from xmlwriter.h
• line 1037: Function xmlTextWriterWriteFormatElement from xmlwriter.h
• line 1060: Function xmlTextWriterStartElement from xmlwriter.h
• line 1067: Function xmlTextWriterWriteElement from xmlwriter.h
• line 1075: Function xmlTextWriterEndElement from xmlwriter.h
• line 1085: Function xmlTextWriterEndDocument from xmlwriter.h
• line 1091: Function xmlFreeTextWriter from xmlwriter.h
• line 1093: Function xmlSaveFileEnc from tree.h
• line 1095: Function xmlFreeDoc from tree.h
• line 1115: Type xmlCharEncodingHandlerPtr from encoding.h
• line 1120: Function xmlFindCharEncodingHandler from encoding.h

Usage:

testWriter

Author: Alfred Mickautsch

Daniel Veillard