| |

|

|

|

Module xinclude from libxml2

|

|

|

|

|

|

| API Menu | |

• Main Menu
• Developer Menu
• Code Examples
• API Menu
• Parser API
• Tree API
• Reader API
• XML Guidelines
• ChangeLog

|

| API Indexes | |

• Alphabetic
• Constructors
• Functions/Types
• Modules
• Symbols

|

| Related links | |

• Mail archive
• XSLT libxslt
• DOM gdome2
• XML-DSig xmlsec
• FTP
• Windows binaries
• Solaris binaries
• MacOsX binaries
• lxml Python bindings
• Perl bindings
• C++ bindings
• PHP bindings
• Pascal bindings
• Ruby bindings
• Tcl bindings
• Bug Tracker

|

|

|

|

|

|

| | valid | | API documentation | | The XML C parser and toolkit of Gnome | xlink | |

API to handle XInclude processing, implements the World Wide Web Consortium Last Call Working Draft 10 November 2003

Table of Contents

#define[XINCLUDE\_FALLBACK](#XINCLUDE_FALLBACK)

#define[XINCLUDE\_HREF](#XINCLUDE_HREF)

#define[XINCLUDE\_NODE](#XINCLUDE_NODE)

#define[XINCLUDE\_NS](#XINCLUDE_NS)

#define[XINCLUDE\_OLD\_NS](#XINCLUDE_OLD_NS)

#define[XINCLUDE\_PARSE](#XINCLUDE_PARSE)

#define[XINCLUDE\_PARSE\_ENCODING](#XINCLUDE_PARSE_ENCODING)

#define[XINCLUDE\_PARSE\_TEXT](#XINCLUDE_PARSE_TEXT)

#define[XINCLUDE\_PARSE\_XML](#XINCLUDE_PARSE_XML)

#define[XINCLUDE\_PARSE\_XPOINTER](#XINCLUDE_PARSE_XPOINTER)

Structure[xmlXIncludeCtxt](#xmlXIncludeCtxt)
struct _xmlXIncludeCtxt
The content of this structure is not made public by the API.

Typedef[xmlXIncludeCtxt](libxml-xinclude.html#xmlXIncludeCtxt)*xmlXIncludeCtxtPtr

void[xmlXIncludeFreeContext](#xmlXIncludeFreeContext)([xmlXIncludeCtxtPtr](libxml-xinclude.html#xmlXIncludeCtxtPtr)ctxt)

[xmlXIncludeCtxtPtr](libxml-xinclude.html#xmlXIncludeCtxtPtr)[xmlXIncludeNewContext](#xmlXIncludeNewContext)([xmlDocPtr](libxml-tree.html#xmlDocPtr)doc)

int[xmlXIncludeProcess](#xmlXIncludeProcess)([xmlDocPtr](libxml-tree.html#xmlDocPtr)doc)

int[xmlXIncludeProcessFlags](#xmlXIncludeProcessFlags)([xmlDocPtr](libxml-tree.html#xmlDocPtr)doc,
int flags)

int[xmlXIncludeProcessFlagsData](#xmlXIncludeProcessFlagsData)([xmlDocPtr](libxml-tree.html#xmlDocPtr)doc,
int flags,
void * data)

int[xmlXIncludeProcessNode](#xmlXIncludeProcessNode)([xmlXIncludeCtxtPtr](libxml-xinclude.html#xmlXIncludeCtxtPtr)ctxt,
[xmlNodePtr](libxml-tree.html#xmlNodePtr)node)

int[xmlXIncludeProcessTree](#xmlXIncludeProcessTree)([xmlNodePtr](libxml-tree.html#xmlNodePtr)tree)

int[xmlXIncludeProcessTreeFlags](#xmlXIncludeProcessTreeFlags)([xmlNodePtr](libxml-tree.html#xmlNodePtr)tree,
int flags)

int[xmlXIncludeProcessTreeFlagsData](#xmlXIncludeProcessTreeFlagsData)([xmlNodePtr](libxml-tree.html#xmlNodePtr)tree,
int flags,
void * data)

int[xmlXIncludeSetFlags](#xmlXIncludeSetFlags)([xmlXIncludeCtxtPtr](libxml-xinclude.html#xmlXIncludeCtxtPtr)ctxt,
int flags)

Description

Macro: XINCLUDE_FALLBACK

#define XINCLUDE_FALLBACK

Macro defining "fallback"

Macro: XINCLUDE_HREF

#define XINCLUDE_HREF

Macro defining "href"

Macro: XINCLUDE_NODE

#define XINCLUDE_NODE

Macro defining "include"

Macro: XINCLUDE_NS

#define XINCLUDE_NS

Macro defining the Xinclude namespace: http://www.w3.org/2003/XInclude

Macro: XINCLUDE_OLD_NS

#define XINCLUDE_OLD_NS

Macro defining the draft Xinclude namespace: http://www.w3.org/2001/XInclude

Macro: XINCLUDE_PARSE

#define XINCLUDE_PARSE

Macro defining "parse"

Macro: XINCLUDE_PARSE_ENCODING

#define XINCLUDE_PARSE_ENCODING

Macro defining "encoding"

Macro: XINCLUDE_PARSE_TEXT

#define XINCLUDE_PARSE_TEXT

Macro defining "text"

Macro: XINCLUDE_PARSE_XML

#define XINCLUDE_PARSE_XML

Macro defining "xml"

Macro: XINCLUDE_PARSE_XPOINTER

#define XINCLUDE_PARSE_XPOINTER

Macro defining "xpointer"

Structure xmlXIncludeCtxt

Structure xmlXIncludeCtxt
struct _xmlXIncludeCtxt {
The content of this structure is not made public by the API.
}

Function: xmlXIncludeFreeContext

void	xmlXIncludeFreeContext ([xmlXIncludeCtxtPtr](libxml-xinclude.html#xmlXIncludeCtxtPtr)ctxt)

Free an XInclude context

| ctxt: | the XInclude context |

Function: xmlXIncludeNewContext

[xmlXIncludeCtxtPtr](libxml-xinclude.html#xmlXIncludeCtxtPtr)xmlXIncludeNewContext	([xmlDocPtr](libxml-tree.html#xmlDocPtr)doc)

Creates a new XInclude context

| doc: | an XML Document | | Returns: | the new set |

Function: xmlXIncludeProcess

int	xmlXIncludeProcess ([xmlDocPtr](libxml-tree.html#xmlDocPtr)doc)

Implement the XInclude substitution on the XML document @doc

| doc: | an XML document | | Returns: | 0 if no substitution were done, -1 if some processing failed or the number of substitutions done. |

Function: xmlXIncludeProcessFlags

int	xmlXIncludeProcessFlags ([xmlDocPtr](libxml-tree.html#xmlDocPtr)doc,
int flags)

Implement the XInclude substitution on the XML document @doc

| doc: | an XML document | | flags: | a set of xmlParserOption used for parsing XML includes | | Returns: | 0 if no substitution were done, -1 if some processing failed or the number of substitutions done. |

Function: xmlXIncludeProcessFlagsData

int	xmlXIncludeProcessFlagsData	([xmlDocPtr](libxml-tree.html#xmlDocPtr)doc,
int flags,
void * data)

Implement the XInclude substitution on the XML document @doc

| doc: | an XML document | | flags: | a set of xmlParserOption used for parsing XML includes | | data: | application data that will be passed to the parser context in the _private field of the parser context(s) | | Returns: | 0 if no substitution were done, -1 if some processing failed or the number of substitutions done. |

Function: xmlXIncludeProcessNode

int	xmlXIncludeProcessNode ([xmlXIncludeCtxtPtr](libxml-xinclude.html#xmlXIncludeCtxtPtr)ctxt,
[xmlNodePtr](libxml-tree.html#xmlNodePtr)node)

Implement the XInclude substitution for the given subtree reusing the informations and data coming from the given context.

| ctxt: | an existing XInclude context | | node: | a node in an XML document | | Returns: | 0 if no substitution were done, -1 if some processing failed or the number of substitutions done. |

Function: xmlXIncludeProcessTree

int	xmlXIncludeProcessTree ([xmlNodePtr](libxml-tree.html#xmlNodePtr)tree)

Implement the XInclude substitution for the given subtree

| tree: | a node in an XML document | | Returns: | 0 if no substitution were done, -1 if some processing failed or the number of substitutions done. |

Function: xmlXIncludeProcessTreeFlags

int	xmlXIncludeProcessTreeFlags	([xmlNodePtr](libxml-tree.html#xmlNodePtr)tree,
int flags)

Implement the XInclude substitution for the given subtree

| tree: | a node in an XML document | | flags: | a set of xmlParserOption used for parsing XML includes | | Returns: | 0 if no substitution were done, -1 if some processing failed or the number of substitutions done. |

Function: xmlXIncludeProcessTreeFlagsData

int	xmlXIncludeProcessTreeFlagsData	([xmlNodePtr](libxml-tree.html#xmlNodePtr)tree,
int flags,
void * data)

Implement the XInclude substitution on the XML node @tree

| tree: | an XML node | | flags: | a set of xmlParserOption used for parsing XML includes | | data: | application data that will be passed to the parser context in the _private field of the parser context(s) | | Returns: | 0 if no substitution were done, -1 if some processing failed or the number of substitutions done. |

Function: xmlXIncludeSetFlags

int	xmlXIncludeSetFlags ([xmlXIncludeCtxtPtr](libxml-xinclude.html#xmlXIncludeCtxtPtr)ctxt,
int flags)

Set the flags used for further processing of XML resources.

| ctxt: | an XInclude processing context | | flags: | a set of xmlParserOption used for parsing XML includes | | Returns: | 0 in case of success and -1 in case of error. |

Daniel Veillard

|

|

|

|

|