blob: 9d497ad86df255c0df2887170fbc3389cde0d293 [file] [log] [blame]
Daniel Veillard9753ad72000-11-13 19:12:23 +00001<HTML
2><HEAD
3><TITLE
4>xinclude</TITLE
5><META
6NAME="GENERATOR"
Daniel Veillard60087f32001-10-10 09:45:09 +00007CONTENT="Modular DocBook HTML Stylesheet Version 1.64
8"><LINK
Daniel Veillard9753ad72000-11-13 19:12:23 +00009REL="HOME"
10TITLE="Gnome XML Library Reference Manual"
11HREF="book1.html"><LINK
12REL="UP"
13TITLE="Libxml Library Reference"
14HREF="libxml-lib.html"><LINK
15REL="PREVIOUS"
16TITLE="xpointer"
Daniel Veillard9cb5ff42001-01-29 08:22:21 +000017HREF="libxml-xpointer.html"><LINK
Daniel Veillard9753ad72000-11-13 19:12:23 +000018REL="NEXT"
19TITLE="nanohttp"
Daniel Veillard9cb5ff42001-01-29 08:22:21 +000020HREF="libxml-nanohttp.html"></HEAD
Daniel Veillard9753ad72000-11-13 19:12:23 +000021><BODY
Daniel Veillardbed7b052001-05-19 14:59:49 +000022CLASS="REFENTRY"
Daniel Veillard9753ad72000-11-13 19:12:23 +000023BGCOLOR="#FFFFFF"
24TEXT="#000000"
Daniel Veillard503b8932001-01-05 06:36:31 +000025LINK="#0000FF"
26VLINK="#840084"
27ALINK="#0000FF"
Daniel Veillard9753ad72000-11-13 19:12:23 +000028><DIV
29CLASS="NAVHEADER"
30><TABLE
31WIDTH="100%"
32BORDER="0"
33BGCOLOR="#000000"
34CELLPADDING="1"
35CELLSPACING="0"
36><TR
37><TH
38COLSPAN="4"
39ALIGN="center"
40><FONT
41COLOR="#FFFFFF"
42SIZE="5"
43>Gnome XML Library Reference Manual</FONT
44></TH
45></TR
46><TR
47><TD
48WIDTH="25%"
49BGCOLOR="#C00000"
50ALIGN="left"
51><A
Daniel Veillard9cb5ff42001-01-29 08:22:21 +000052HREF="libxml-xpointer.html"
Daniel Veillard9753ad72000-11-13 19:12:23 +000053><FONT
54COLOR="#FFFFFF"
55SIZE="3"
56><B
57>&#60;&#60;&#60; Previous Page</B
58></FONT
59></A
60></TD
61><TD
62WIDTH="25%"
63BGCOLOR="#0000C0"
64ALIGN="center"
65><FONT
66COLOR="#FFFFFF"
67SIZE="3"
68><B
69><A
70HREF="book1.html"
71><FONT
72COLOR="#FFFFFF"
73SIZE="3"
74><B
75>Home</B
76></FONT
77></A
78></B
79></FONT
80></TD
81><TD
82WIDTH="25%"
83BGCOLOR="#00C000"
84ALIGN="center"
85><FONT
86COLOR="#FFFFFF"
87SIZE="3"
88><B
89><A
90HREF="libxml-lib.html"
91><FONT
92COLOR="#FFFFFF"
93SIZE="3"
94><B
95>Up</B
96></FONT
97></A
98></B
99></FONT
100></TD
101><TD
102WIDTH="25%"
103BGCOLOR="#C00000"
104ALIGN="right"
105><A
Daniel Veillard9cb5ff42001-01-29 08:22:21 +0000106HREF="libxml-nanohttp.html"
Daniel Veillard9753ad72000-11-13 19:12:23 +0000107><FONT
108COLOR="#FFFFFF"
109SIZE="3"
110><B
111>Next Page &#62;&#62;&#62;</B
112></FONT
113></A
114></TD
115></TR
116></TABLE
117></DIV
118><H1
Daniel Veillard503b8932001-01-05 06:36:31 +0000119><A
Daniel Veillard9cb5ff42001-01-29 08:22:21 +0000120NAME="LIBXML-XINCLUDE"
Daniel Veillard503b8932001-01-05 06:36:31 +0000121>xinclude</A
122></H1
Daniel Veillard9753ad72000-11-13 19:12:23 +0000123><DIV
124CLASS="REFNAMEDIV"
125><A
Daniel Veillard60087f32001-10-10 09:45:09 +0000126NAME="AEN16808"
Daniel Veillard9753ad72000-11-13 19:12:23 +0000127></A
128><H2
129>Name</H2
Daniel Veillard503b8932001-01-05 06:36:31 +0000130>xinclude&nbsp;--&nbsp;</DIV
Daniel Veillard9753ad72000-11-13 19:12:23 +0000131><DIV
132CLASS="REFSYNOPSISDIV"
133><A
Daniel Veillard60087f32001-10-10 09:45:09 +0000134NAME="AEN16811"
Daniel Veillard9753ad72000-11-13 19:12:23 +0000135></A
136><H2
137>Synopsis</H2
138><TABLE
139BORDER="0"
140BGCOLOR="#D6E8FF"
141WIDTH="100%"
142CELLPADDING="6"
143><TR
144><TD
145><PRE
146CLASS="SYNOPSIS"
147>&#13;
148
149int <A
Daniel Veillard9cb5ff42001-01-29 08:22:21 +0000150HREF="libxml-xinclude.html#XMLXINCLUDEPROCESS"
Daniel Veillard9753ad72000-11-13 19:12:23 +0000151>xmlXIncludeProcess</A
152> (<A
Daniel Veillard9cb5ff42001-01-29 08:22:21 +0000153HREF="libxml-tree.html#XMLDOCPTR"
Daniel Veillard9753ad72000-11-13 19:12:23 +0000154>xmlDocPtr</A
155> doc);</PRE
156></TD
157></TR
158></TABLE
159></DIV
160><DIV
161CLASS="REFSECT1"
162><A
Daniel Veillard60087f32001-10-10 09:45:09 +0000163NAME="AEN16816"
Daniel Veillard9753ad72000-11-13 19:12:23 +0000164></A
165><H2
166>Description</H2
167><P
168></P
169></DIV
170><DIV
171CLASS="REFSECT1"
172><A
Daniel Veillard60087f32001-10-10 09:45:09 +0000173NAME="AEN16819"
Daniel Veillard9753ad72000-11-13 19:12:23 +0000174></A
175><H2
176>Details</H2
177><DIV
178CLASS="REFSECT2"
179><A
Daniel Veillard60087f32001-10-10 09:45:09 +0000180NAME="AEN16821"
Daniel Veillard9753ad72000-11-13 19:12:23 +0000181></A
182><H3
183><A
184NAME="XMLXINCLUDEPROCESS"
185></A
186>xmlXIncludeProcess ()</H3
187><TABLE
188BORDER="0"
189BGCOLOR="#D6E8FF"
190WIDTH="100%"
191CELLPADDING="6"
192><TR
193><TD
194><PRE
195CLASS="PROGRAMLISTING"
196>int xmlXIncludeProcess (<A
Daniel Veillard9cb5ff42001-01-29 08:22:21 +0000197HREF="libxml-tree.html#XMLDOCPTR"
Daniel Veillard9753ad72000-11-13 19:12:23 +0000198>xmlDocPtr</A
199> doc);</PRE
200></TD
201></TR
202></TABLE
203><P
204>Implement the XInclude substitution on the XML document <TT
205CLASS="PARAMETER"
206><I
207>doc</I
208></TT
209></P
210><P
211></P
212><DIV
213CLASS="INFORMALTABLE"
Daniel Veillardbed7b052001-05-19 14:59:49 +0000214><A
Daniel Veillard60087f32001-10-10 09:45:09 +0000215NAME="AEN16829"
Daniel Veillardbed7b052001-05-19 14:59:49 +0000216></A
Daniel Veillard9753ad72000-11-13 19:12:23 +0000217><P
218></P
219><TABLE
220BORDER="0"
221WIDTH="100%"
222BGCOLOR="#FFD0D0"
223CELLSPACING="0"
224CELLPADDING="4"
225CLASS="CALSTABLE"
Daniel Veillardbed7b052001-05-19 14:59:49 +0000226><TBODY
Daniel Veillard9753ad72000-11-13 19:12:23 +0000227><TR
228><TD
229WIDTH="20%"
230ALIGN="RIGHT"
231VALIGN="TOP"
232><TT
233CLASS="PARAMETER"
234><I
235>doc</I
236></TT
Daniel Veillard3bbbe6f2001-05-03 11:15:37 +0000237>&nbsp;:</TD
Daniel Veillard9753ad72000-11-13 19:12:23 +0000238><TD
239WIDTH="80%"
240ALIGN="LEFT"
241VALIGN="TOP"
Daniel Veillard4b8328d2001-07-05 22:48:42 +0000242> an XML document</TD
Daniel Veillard9753ad72000-11-13 19:12:23 +0000243></TR
244><TR
245><TD
246WIDTH="20%"
247ALIGN="RIGHT"
248VALIGN="TOP"
249><I
250CLASS="EMPHASIS"
251>Returns</I
252> :</TD
253><TD
254WIDTH="80%"
255ALIGN="LEFT"
256VALIGN="TOP"
Daniel Veillard4b8328d2001-07-05 22:48:42 +0000257>0 if no substition were done, -1 if some processing failed
258or the number of substitutions done.</TD
Daniel Veillard9753ad72000-11-13 19:12:23 +0000259></TR
Daniel Veillardbed7b052001-05-19 14:59:49 +0000260></TBODY
Daniel Veillard9753ad72000-11-13 19:12:23 +0000261></TABLE
262><P
263></P
264></DIV
265></DIV
266></DIV
267><DIV
268CLASS="NAVFOOTER"
269><BR
270CLEAR="all"><BR><TABLE
271WIDTH="100%"
272BORDER="0"
273BGCOLOR="#000000"
274CELLPADDING="1"
275CELLSPACING="0"
276><TR
277><TD
278WIDTH="25%"
279BGCOLOR="#C00000"
280ALIGN="left"
281><A
Daniel Veillard9cb5ff42001-01-29 08:22:21 +0000282HREF="libxml-xpointer.html"
Daniel Veillard9753ad72000-11-13 19:12:23 +0000283><FONT
284COLOR="#FFFFFF"
285SIZE="3"
286><B
287>&#60;&#60;&#60; Previous Page</B
288></FONT
289></A
290></TD
291><TD
292WIDTH="25%"
293BGCOLOR="#0000C0"
294ALIGN="center"
295><FONT
296COLOR="#FFFFFF"
297SIZE="3"
298><B
299><A
300HREF="book1.html"
301><FONT
302COLOR="#FFFFFF"
303SIZE="3"
304><B
305>Home</B
306></FONT
307></A
308></B
309></FONT
310></TD
311><TD
312WIDTH="25%"
313BGCOLOR="#00C000"
314ALIGN="center"
315><FONT
316COLOR="#FFFFFF"
317SIZE="3"
318><B
319><A
320HREF="libxml-lib.html"
321><FONT
322COLOR="#FFFFFF"
323SIZE="3"
324><B
325>Up</B
326></FONT
327></A
328></B
329></FONT
330></TD
331><TD
332WIDTH="25%"
333BGCOLOR="#C00000"
334ALIGN="right"
335><A
Daniel Veillard9cb5ff42001-01-29 08:22:21 +0000336HREF="libxml-nanohttp.html"
Daniel Veillard9753ad72000-11-13 19:12:23 +0000337><FONT
338COLOR="#FFFFFF"
339SIZE="3"
340><B
341>Next Page &#62;&#62;&#62;</B
342></FONT
343></A
344></TD
345></TR
346><TR
347><TD
348COLSPAN="2"
349ALIGN="left"
350><FONT
351COLOR="#FFFFFF"
352SIZE="3"
353><B
354>xpointer</B
355></FONT
356></TD
357><TD
358COLSPAN="2"
359ALIGN="right"
360><FONT
361COLOR="#FFFFFF"
362SIZE="3"
363><B
364>nanohttp</B
365></FONT
366></TD
367></TR
368></TABLE
369></DIV
370></BODY
371></HTML
372>