ContextQMD
Back to Turicreate

xinclude: implementation of XInclude

deps/src/libxml2-2.9.1/doc/devhelp/libxml2-xinclude.html

6.4.17.8 KB
Original Source

| | | | | libxml2 Reference Manual |

xinclude

xinclude - implementation of XInclude

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

Author(s): Daniel Veillard

Synopsis

#define[XINCLUDE\_PARSE\_TEXT](#XINCLUDE_PARSE_TEXT);
#define[XINCLUDE\_PARSE\_XPOINTER](#XINCLUDE_PARSE_XPOINTER);
#define[XINCLUDE\_HREF](#XINCLUDE_HREF);
#define[XINCLUDE\_FALLBACK](#XINCLUDE_FALLBACK);
#define[XINCLUDE\_NS](#XINCLUDE_NS);
#define[XINCLUDE\_PARSE](#XINCLUDE_PARSE);
#define[XINCLUDE\_NODE](#XINCLUDE_NODE);
#define[XINCLUDE\_PARSE\_XML](#XINCLUDE_PARSE_XML);
#define[XINCLUDE\_PARSE\_ENCODING](#XINCLUDE_PARSE_ENCODING);
#define[XINCLUDE\_OLD\_NS](#XINCLUDE_OLD_NS);
typedef struct _xmlXIncludeCtxt[xmlXIncludeCtxt](#xmlXIncludeCtxt);
typedef[xmlXIncludeCtxt](libxml2-xinclude.html#xmlXIncludeCtxt)*[xmlXIncludeCtxtPtr](#xmlXIncludeCtxtPtr);
int[xmlXIncludeProcessTreeFlagsData](#xmlXIncludeProcessTreeFlagsData)([xmlNodePtr](libxml2-tree.html#xmlNodePtr)tree,
int flags,
void * data);
int[xmlXIncludeProcessFlagsData](#xmlXIncludeProcessFlagsData)([xmlDocPtr](libxml2-tree.html#xmlDocPtr)doc,
int flags,
void * data);
int[xmlXIncludeProcessFlags](#xmlXIncludeProcessFlags)([xmlDocPtr](libxml2-tree.html#xmlDocPtr)doc,
int flags);
int[xmlXIncludeProcessTree](#xmlXIncludeProcessTree)([xmlNodePtr](libxml2-tree.html#xmlNodePtr)tree);
int[xmlXIncludeProcessNode](#xmlXIncludeProcessNode)([xmlXIncludeCtxtPtr](libxml2-xinclude.html#xmlXIncludeCtxtPtr)ctxt,
[xmlNodePtr](libxml2-tree.html#xmlNodePtr)node);
void[xmlXIncludeFreeContext](#xmlXIncludeFreeContext)([xmlXIncludeCtxtPtr](libxml2-xinclude.html#xmlXIncludeCtxtPtr)ctxt);
int[xmlXIncludeSetFlags](#xmlXIncludeSetFlags)([xmlXIncludeCtxtPtr](libxml2-xinclude.html#xmlXIncludeCtxtPtr)ctxt,
int flags);
int[xmlXIncludeProcess](#xmlXIncludeProcess)([xmlDocPtr](libxml2-tree.html#xmlDocPtr)doc);[xmlXIncludeCtxtPtr](libxml2-xinclude.html#xmlXIncludeCtxtPtr)[xmlXIncludeNewContext](#xmlXIncludeNewContext)([xmlDocPtr](libxml2-tree.html#xmlDocPtr)doc);
int[xmlXIncludeProcessTreeFlags](#xmlXIncludeProcessTreeFlags)([xmlNodePtr](libxml2-tree.html#xmlNodePtr)tree,
int flags);

Description

Details

Macro XINCLUDE_FALLBACK

#define[XINCLUDE\_FALLBACK](#XINCLUDE_FALLBACK);

Macro defining "fallback"

Macro XINCLUDE_HREF

#define[XINCLUDE\_HREF](#XINCLUDE_HREF);

Macro defining "href"

Macro XINCLUDE_NODE

#define[XINCLUDE\_NODE](#XINCLUDE_NODE);

Macro defining "include"

Macro XINCLUDE_NS

#define[XINCLUDE\_NS](#XINCLUDE_NS);

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

Macro XINCLUDE_OLD_NS

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

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

Macro XINCLUDE_PARSE

#define[XINCLUDE\_PARSE](#XINCLUDE_PARSE);

Macro defining "parse"

Macro XINCLUDE_PARSE_ENCODING

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

Macro defining "encoding"

Macro XINCLUDE_PARSE_TEXT

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

Macro defining "text"

Macro XINCLUDE_PARSE_XML

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

Macro defining "xml"

Macro XINCLUDE_PARSE_XPOINTER

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

Macro defining "xpointer"

Structure xmlXIncludeCtxt

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

Typedef xmlXIncludeCtxtPtr

[xmlXIncludeCtxt](libxml2-xinclude.html#xmlXIncludeCtxt)* xmlXIncludeCtxtPtr;

xmlXIncludeFreeContext ()

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

Free an XInclude context

| ctxt: | the XInclude context |

xmlXIncludeNewContext ()

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

Creates a new XInclude context

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

xmlXIncludeProcess ()

int	xmlXIncludeProcess ([xmlDocPtr](libxml2-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. |

xmlXIncludeProcessFlags ()

int	xmlXIncludeProcessFlags ([xmlDocPtr](libxml2-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. |

xmlXIncludeProcessFlagsData ()

int	xmlXIncludeProcessFlagsData	([xmlDocPtr](libxml2-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. |

xmlXIncludeProcessNode ()

int	xmlXIncludeProcessNode ([xmlXIncludeCtxtPtr](libxml2-xinclude.html#xmlXIncludeCtxtPtr)ctxt,
[xmlNodePtr](libxml2-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. |

xmlXIncludeProcessTree ()

int	xmlXIncludeProcessTree ([xmlNodePtr](libxml2-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. |

xmlXIncludeProcessTreeFlags ()

int	xmlXIncludeProcessTreeFlags	([xmlNodePtr](libxml2-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. |

xmlXIncludeProcessTreeFlagsData ()

int	xmlXIncludeProcessTreeFlagsData	([xmlNodePtr](libxml2-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. |

xmlXIncludeSetFlags ()

int	xmlXIncludeSetFlags ([xmlXIncludeCtxtPtr](libxml2-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. |