libxml2/doc/html/libxml-xinclude.html

   1 <HTML
   2 ><HEAD
   3 ><TITLE
   4 >xinclude</TITLE
   5 ><META
   6 NAME="GENERATOR"
   7 CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
   8 "><LINK
   9 REL="HOME"
  10 TITLE="Gnome XML Library Reference Manual"
  11 HREF="book1.html"><LINK
  12 REL="UP"
  13 TITLE="Libxml Library Reference"
  14 HREF="libxml-lib.html"><LINK
  15 REL="PREVIOUS"
  16 TITLE="xpointer"
  17 HREF="libxml-xpointer.html"><LINK
  18 REL="NEXT"
  19 TITLE="nanohttp"
  20 HREF="libxml-nanohttp.html"></HEAD
  21 ><BODY
  22 CLASS="REFENTRY"
  23 BGCOLOR="#FFFFFF"
  24 TEXT="#000000"
  25 LINK="#0000FF"
  26 VLINK="#840084"
  27 ALINK="#0000FF"
  28 ><DIV
  29 CLASS="NAVHEADER"
  30 ><TABLE
  31 WIDTH="100%"
  32 BORDER="0"
  33 BGCOLOR="#000000"
  34 CELLPADDING="1"
  35 CELLSPACING="0"
  36 ><TR
  37 ><TH
  38 COLSPAN="4"
  39 ALIGN="center"
  40 ><FONT
  41 COLOR="#FFFFFF"
  42 SIZE="5"
  43 >Gnome XML Library Reference Manual</FONT
  44 ></TH
  45 ></TR
  46 ><TR
  47 ><TD
  48 WIDTH="25%"
  49 BGCOLOR="#C00000"
  50 ALIGN="left"
  51 ><A
  52 HREF="libxml-xpointer.html"
  53 ><FONT
  54 COLOR="#FFFFFF"
  55 SIZE="3"
  56 ><B
  57 >&#60;&#60;&#60; Previous Page</B
  58 ></FONT
  59 ></A
  60 ></TD
  61 ><TD
  62 WIDTH="25%"
  63 BGCOLOR="#0000C0"
  64 ALIGN="center"
  65 ><FONT
  66 COLOR="#FFFFFF"
  67 SIZE="3"
  68 ><B
  69 ><A
  70 HREF="book1.html"
  71 ><FONT
  72 COLOR="#FFFFFF"
  73 SIZE="3"
  74 ><B
  75 >Home</B
  76 ></FONT
  77 ></A
  78 ></B
  79 ></FONT
  80 ></TD
  81 ><TD
  82 WIDTH="25%"
  83 BGCOLOR="#00C000"
  84 ALIGN="center"
  85 ><FONT
  86 COLOR="#FFFFFF"
  87 SIZE="3"
  88 ><B
  89 ><A
  90 HREF="libxml-lib.html"
  91 ><FONT
  92 COLOR="#FFFFFF"
  93 SIZE="3"
  94 ><B
  95 >Up</B
  96 ></FONT
  97 ></A
  98 ></B
  99 ></FONT
 100 ></TD
 101 ><TD
 102 WIDTH="25%"
 103 BGCOLOR="#C00000"
 104 ALIGN="right"
 105 ><A
 106 HREF="libxml-nanohttp.html"
 107 ><FONT
 108 COLOR="#FFFFFF"
 109 SIZE="3"
 110 ><B
 111 >Next Page &#62;&#62;&#62;</B
 112 ></FONT
 113 ></A
 114 ></TD
 115 ></TR
 116 ></TABLE
 117 ></DIV
 118 ><H1
 119 ><A
 120 NAME="LIBXML-XINCLUDE">xinclude</H1
 121 ><DIV
 122 CLASS="REFNAMEDIV"
 123 ><A
 124 NAME="AEN17696"
 125 ></A
 126 ><H2
 127 >Name</H2
 128 >xinclude&nbsp;--&nbsp;</DIV
 129 ><DIV
 130 CLASS="REFSYNOPSISDIV"
 131 ><A
 132 NAME="AEN17699"><H2
 133 >Synopsis</H2
 134 ><TABLE
 135 BORDER="0"
 136 BGCOLOR="#D6E8FF"
 137 WIDTH="100%"
 138 CELLPADDING="6"
 139 ><TR
 140 ><TD
 141 ><PRE
 142 CLASS="SYNOPSIS"
 143 >&#13;
 144
 145 int         <A
 146 HREF="libxml-xinclude.html#XMLXINCLUDEPROCESS"
 147 >xmlXIncludeProcess</A
 148 >              (<A
 149 HREF="libxml-tree.html#XMLDOCPTR"
 150 >xmlDocPtr</A
 151 > doc);</PRE
 152 ></TD
 153 ></TR
 154 ></TABLE
 155 ></DIV
 156 ><DIV
 157 CLASS="REFSECT1"
 158 ><A
 159 NAME="AEN17704"
 160 ></A
 161 ><H2
 162 >Description</H2
 163 ><P
 164 ></P
 165 ></DIV
 166 ><DIV
 167 CLASS="REFSECT1"
 168 ><A
 169 NAME="AEN17707"
 170 ></A
 171 ><H2
 172 >Details</H2
 173 ><DIV
 174 CLASS="REFSECT2"
 175 ><A
 176 NAME="AEN17709"
 177 ></A
 178 ><H3
 179 ><A
 180 NAME="XMLXINCLUDEPROCESS"
 181 ></A
 182 >xmlXIncludeProcess ()</H3
 183 ><TABLE
 184 BORDER="0"
 185 BGCOLOR="#D6E8FF"
 186 WIDTH="100%"
 187 CELLPADDING="6"
 188 ><TR
 189 ><TD
 190 ><PRE
 191 CLASS="PROGRAMLISTING"
 192 >int         xmlXIncludeProcess              (<A
 193 HREF="libxml-tree.html#XMLDOCPTR"
 194 >xmlDocPtr</A
 195 > doc);</PRE
 196 ></TD
 197 ></TR
 198 ></TABLE
 199 ><P
 200 >Implement the XInclude substitution on the XML document <TT
 201 CLASS="PARAMETER"
 202 ><I
 203 >doc</I
 204 ></TT
 205 ></P
 206 ><P
 207 ></P
 208 ><DIV
 209 CLASS="INFORMALTABLE"
 210 ><A
 211 NAME="AEN17717"><P
 212 ></P
 213 ><TABLE
 214 BORDER="0"
 215 WIDTH="100%"
 216 BGCOLOR="#FFD0D0"
 217 CELLSPACING="0"
 218 CELLPADDING="4"
 219 CLASS="CALSTABLE"
 220 ><TBODY
 221 ><TR
 222 ><TD
 223 WIDTH="20%"
 224 ALIGN="RIGHT"
 225 VALIGN="TOP"
 226 ><TT
 227 CLASS="PARAMETER"
 228 ><I
 229 >doc</I
 230 ></TT
 231 >&nbsp;:</TD
 232 ><TD
 233 WIDTH="80%"
 234 ALIGN="LEFT"
 235 VALIGN="TOP"
 236 > an XML document</TD
 237 ></TR
 238 ><TR
 239 ><TD
 240 WIDTH="20%"
 241 ALIGN="RIGHT"
 242 VALIGN="TOP"
 243 ><SPAN
 244 CLASS="emphasis"
 245 ><I
 246 CLASS="EMPHASIS"
 247 >Returns</I
 248 ></SPAN
 249 > :</TD
 250 ><TD
 251 WIDTH="80%"
 252 ALIGN="LEFT"
 253 VALIGN="TOP"
 254 >0 if no substitution were done, -1 if some processing failed
 255 or the number of substitutions done.</TD
 256 ></TR
 257 ></TBODY
 258 ></TABLE
 259 ><P
 260 ></P
 261 ></DIV
 262 ></DIV
 263 ></DIV
 264 ><DIV
 265 CLASS="NAVFOOTER"
 266 ><BR
 267 CLEAR="all"><BR><TABLE
 268 WIDTH="100%"
 269 BORDER="0"
 270 BGCOLOR="#000000"
 271 CELLPADDING="1"
 272 CELLSPACING="0"
 273 ><TR
 274 ><TD
 275 WIDTH="25%"
 276 BGCOLOR="#C00000"
 277 ALIGN="left"
 278 ><A
 279 HREF="libxml-xpointer.html"
 280 ><FONT
 281 COLOR="#FFFFFF"
 282 SIZE="3"
 283 ><B
 284 >&#60;&#60;&#60; Previous Page</B
 285 ></FONT
 286 ></A
 287 ></TD
 288 ><TD
 289 WIDTH="25%"
 290 BGCOLOR="#0000C0"
 291 ALIGN="center"
 292 ><FONT
 293 COLOR="#FFFFFF"
 294 SIZE="3"
 295 ><B
 296 ><A
 297 HREF="book1.html"
 298 ><FONT
 299 COLOR="#FFFFFF"
 300 SIZE="3"
 301 ><B
 302 >Home</B
 303 ></FONT
 304 ></A
 305 ></B
 306 ></FONT
 307 ></TD
 308 ><TD
 309 WIDTH="25%"
 310 BGCOLOR="#00C000"
 311 ALIGN="center"
 312 ><FONT
 313 COLOR="#FFFFFF"
 314 SIZE="3"
 315 ><B
 316 ><A
 317 HREF="libxml-lib.html"
 318 ><FONT
 319 COLOR="#FFFFFF"
 320 SIZE="3"
 321 ><B
 322 >Up</B
 323 ></FONT
 324 ></A
 325 ></B
 326 ></FONT
 327 ></TD
 328 ><TD
 329 WIDTH="25%"
 330 BGCOLOR="#C00000"
 331 ALIGN="right"
 332 ><A
 333 HREF="libxml-nanohttp.html"
 334 ><FONT
 335 COLOR="#FFFFFF"
 336 SIZE="3"
 337 ><B
 338 >Next Page &#62;&#62;&#62;</B
 339 ></FONT
 340 ></A
 341 ></TD
 342 ></TR
 343 ><TR
 344 ><TD
 345 COLSPAN="2"
 346 ALIGN="left"
 347 ><FONT
 348 COLOR="#FFFFFF"
 349 SIZE="3"
 350 ><B
 351 >xpointer</B
 352 ></FONT
 353 ></TD
 354 ><TD
 355 COLSPAN="2"
 356 ALIGN="right"
 357 ><FONT
 358 COLOR="#FFFFFF"
 359 SIZE="3"
 360 ><B
 361 >nanohttp</B
 362 ></FONT
 363 ></TD
 364 ></TR
 365 ></TABLE
 366 ></DIV
 367 ></BODY
 368 ></HTML
 369 >