Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / libxml2 / 3500838f65e6eda8e943c620d5eb9da3109e3766 / . / doc / html / gnome-xml-htmltree.html
blob: 249e4acf2015f596428d38944c072ac42ed823fa [file] [log] [blame]
Daniel Veillard1566d3a1999-07-15 14:24:29 +0000[diff] [blame]1<HTML
2><HEAD
3><TITLE
4>HTMLtree</TITLE
5><META
6NAME="GENERATOR"
7CONTENT="Modular DocBook HTML Stylesheet Version 1.33"><LINK
8REL="HOME"
9TITLE="Gnome XML Library Reference Manual"
10HREF="book1.html"><LINK
11REL="UP"
Daniel Veillard35008381999-10-25 13:15:52 +0000[diff] [blame^]12TITLE="Libxml Library Reference"
13HREF="libxml-lib.html"><LINK
Daniel Veillard1566d3a1999-07-15 14:24:29 +0000[diff] [blame]14REL="PREVIOUS"
15TITLE="HTMLparser"
16HREF="gnome-xml-htmlparser.html"><LINK
17REL="NEXT"
18TITLE="xpath"
19HREF="gnome-xml-xpath.html"></HEAD
20><BODY
21BGCOLOR="#FFFFFF"
22TEXT="#000000"
23><DIV
24CLASS="NAVHEADER"
25><TABLE
26WIDTH="100%"
27BORDER="0"
28BGCOLOR="#000000"
29CELLPADDING="1"
30CELLSPACING="0"
31><TR
32><TH
33COLSPAN="4"
34ALIGN="center"
35><FONT
36COLOR="#FFFFFF"
37SIZE="5"
38>Gnome XML Library Reference Manual</FONT
39></TH
40></TR
41><TR
42><TD
43WIDTH="25%"
44BGCOLOR="#C00000"
45ALIGN="left"
46><A
47HREF="gnome-xml-htmlparser.html"
48><FONT
49COLOR="#FFFFFF"
50SIZE="3"
51><B
52>&#60;&#60;&#60; Previous Page</B
53></FONT
54></A
55></TD
56><TD
57WIDTH="25%"
58BGCOLOR="#0000C0"
59ALIGN="center"
60><FONT
61COLOR="#FFFFFF"
62SIZE="3"
63><B
64><A
65HREF="book1.html"
66><FONT
67COLOR="#FFFFFF"
68SIZE="3"
69><B
70>Home</B
71></FONT
72></A
73></B
74></FONT
75></TD
76><TD
77WIDTH="25%"
78BGCOLOR="#00C000"
79ALIGN="center"
80><FONT
81COLOR="#FFFFFF"
82SIZE="3"
83><B
84><A
Daniel Veillard35008381999-10-25 13:15:52 +0000[diff] [blame^]85HREF="libxml-lib.html"
Daniel Veillard1566d3a1999-07-15 14:24:29 +0000[diff] [blame]86><FONT
87COLOR="#FFFFFF"
88SIZE="3"
89><B
90>Up</B
91></FONT
92></A
93></B
94></FONT
95></TD
96><TD
97WIDTH="25%"
98BGCOLOR="#C00000"
99ALIGN="right"
100><A
101HREF="gnome-xml-xpath.html"
102><FONT
103COLOR="#FFFFFF"
104SIZE="3"
105><B
106>Next Page &#62;&#62;&#62;</B
107></FONT
108></A
109></TD
110></TR
111></TABLE
112></DIV
113><H1
114>HTMLtree</H1
115><DIV
116CLASS="REFNAMEDIV"
117><A
Daniel Veillard35008381999-10-25 13:15:52 +0000[diff] [blame^]118NAME="AEN6628"
Daniel Veillard1566d3a1999-07-15 14:24:29 +0000[diff] [blame]119></A
120><H2
121>Name</H2
122>HTMLtree &#8212; </DIV
123><DIV
124CLASS="REFSYNOPSISDIV"
125><A
Daniel Veillard35008381999-10-25 13:15:52 +0000[diff] [blame^]126NAME="AEN6631"
Daniel Veillard1566d3a1999-07-15 14:24:29 +0000[diff] [blame]127></A
128><H2
129>Synopsis</H2
130><TABLE
131BORDER="0"
132BGCOLOR="#D6E8FF"
133WIDTH="100%"
134CELLPADDING="6"
135><TR
136><TD
137><PRE
138CLASS="SYNOPSIS"
139>&#13;
140
141#define <A
142HREF="gnome-xml-htmltree.html#HTML-TEXT-NODE"
143>HTML_TEXT_NODE</A
144>
145#define <A
146HREF="gnome-xml-htmltree.html#HTML-ENTITY-REF-NODE"
147>HTML_ENTITY_REF_NODE</A
148>
149#define <A
150HREF="gnome-xml-htmltree.html#HTML-COMMENT-NODE"
151>HTML_COMMENT_NODE</A
152>
153void <A
154HREF="gnome-xml-htmltree.html#HTMLDOCDUMPMEMORY"
155>htmlDocDumpMemory</A
156> (<A
157HREF="gnome-xml-tree.html#XMLDOCPTR"
158>xmlDocPtr</A
159> cur,
160 <A
Daniel Veillarddd6b3671999-09-23 22:19:22 +0000[diff] [blame]161HREF="gnome-xml-tree.html#XMLCHAR"
162>xmlChar</A
Daniel Veillard1566d3a1999-07-15 14:24:29 +0000[diff] [blame]163> **mem,
164 int *size);
165void <A
166HREF="gnome-xml-htmltree.html#HTMLDOCDUMP"
167>htmlDocDump</A
168> (<GTKDOCLINK
169HREF="FILE"
170>FILE</GTKDOCLINK
171> *f,
172 <A
173HREF="gnome-xml-tree.html#XMLDOCPTR"
174>xmlDocPtr</A
175> cur);
176int <A
177HREF="gnome-xml-htmltree.html#HTMLSAVEFILE"
178>htmlSaveFile</A
179> (const char *filename,
180 <A
181HREF="gnome-xml-tree.html#XMLDOCPTR"
182>xmlDocPtr</A
183> cur);</PRE
184></TD
185></TR
186></TABLE
187></DIV
188><DIV
189CLASS="REFSECT1"
190><A
Daniel Veillard35008381999-10-25 13:15:52 +0000[diff] [blame^]191NAME="AEN6645"
Daniel Veillard1566d3a1999-07-15 14:24:29 +0000[diff] [blame]192></A
193><H2
194>Description</H2
195><P
196></P
197></DIV
198><DIV
199CLASS="REFSECT1"
200><A
Daniel Veillard35008381999-10-25 13:15:52 +0000[diff] [blame^]201NAME="AEN6648"
Daniel Veillard1566d3a1999-07-15 14:24:29 +0000[diff] [blame]202></A
203><H2
204>Details</H2
205><DIV
206CLASS="REFSECT2"
207><A
Daniel Veillard35008381999-10-25 13:15:52 +0000[diff] [blame^]208NAME="AEN6650"
Daniel Veillard1566d3a1999-07-15 14:24:29 +0000[diff] [blame]209></A
210><H3
211><A
212NAME="HTML-TEXT-NODE"
213></A
214>HTML_TEXT_NODE</H3
215><TABLE
216BORDER="0"
217BGCOLOR="#D6E8FF"
218WIDTH="100%"
219CELLPADDING="6"
220><TR
221><TD
222><PRE
223CLASS="PROGRAMLISTING"
Daniel Veillard35008381999-10-25 13:15:52 +0000[diff] [blame^]224>#define HTML_TEXT_NODE XML_TEXT_NODE</PRE
Daniel Veillard1566d3a1999-07-15 14:24:29 +0000[diff] [blame]225></TD
226></TR
227></TABLE
228><P
229></P
230></DIV
231><HR><DIV
232CLASS="REFSECT2"
233><A
Daniel Veillard35008381999-10-25 13:15:52 +0000[diff] [blame^]234NAME="AEN6655"
Daniel Veillard1566d3a1999-07-15 14:24:29 +0000[diff] [blame]235></A
236><H3
237><A
238NAME="HTML-ENTITY-REF-NODE"
239></A
240>HTML_ENTITY_REF_NODE</H3
241><TABLE
242BORDER="0"
243BGCOLOR="#D6E8FF"
244WIDTH="100%"
245CELLPADDING="6"
246><TR
247><TD
248><PRE
249CLASS="PROGRAMLISTING"
Daniel Veillard35008381999-10-25 13:15:52 +0000[diff] [blame^]250>#define HTML_ENTITY_REF_NODE XML_ENTITY_REF_NODE</PRE
Daniel Veillard1566d3a1999-07-15 14:24:29 +0000[diff] [blame]251></TD
252></TR
253></TABLE
254><P
255></P
256></DIV
257><HR><DIV
258CLASS="REFSECT2"
259><A
Daniel Veillard35008381999-10-25 13:15:52 +0000[diff] [blame^]260NAME="AEN6660"
Daniel Veillard1566d3a1999-07-15 14:24:29 +0000[diff] [blame]261></A
262><H3
263><A
264NAME="HTML-COMMENT-NODE"
265></A
266>HTML_COMMENT_NODE</H3
267><TABLE
268BORDER="0"
269BGCOLOR="#D6E8FF"
270WIDTH="100%"
271CELLPADDING="6"
272><TR
273><TD
274><PRE
275CLASS="PROGRAMLISTING"
Daniel Veillard35008381999-10-25 13:15:52 +0000[diff] [blame^]276>#define HTML_COMMENT_NODE XML_COMMENT_NODE</PRE
Daniel Veillard1566d3a1999-07-15 14:24:29 +0000[diff] [blame]277></TD
278></TR
279></TABLE
280><P
281></P
282></DIV
283><HR><DIV
284CLASS="REFSECT2"
285><A
Daniel Veillard35008381999-10-25 13:15:52 +0000[diff] [blame^]286NAME="AEN6665"
Daniel Veillard1566d3a1999-07-15 14:24:29 +0000[diff] [blame]287></A
288><H3
289><A
290NAME="HTMLDOCDUMPMEMORY"
291></A
292>htmlDocDumpMemory ()</H3
293><TABLE
294BORDER="0"
295BGCOLOR="#D6E8FF"
296WIDTH="100%"
297CELLPADDING="6"
298><TR
299><TD
300><PRE
301CLASS="PROGRAMLISTING"
302>void htmlDocDumpMemory (<A
303HREF="gnome-xml-tree.html#XMLDOCPTR"
304>xmlDocPtr</A
305> cur,
306 <A
Daniel Veillarddd6b3671999-09-23 22:19:22 +0000[diff] [blame]307HREF="gnome-xml-tree.html#XMLCHAR"
308>xmlChar</A
Daniel Veillard1566d3a1999-07-15 14:24:29 +0000[diff] [blame]309> **mem,
310 int *size);</PRE
311></TD
312></TR
313></TABLE
314><P
Daniel Veillarddd6b3671999-09-23 22:19:22 +0000[diff] [blame]315>Dump an HTML document in memory and return the xmlChar * and it's size.
Daniel Veillard1566d3a1999-07-15 14:24:29 +0000[diff] [blame]316It's up to the caller to free the memory.</P
317><P
318></P
319><DIV
320CLASS="INFORMALTABLE"
321><P
322></P
323><TABLE
324BORDER="0"
325WIDTH="100%"
326BGCOLOR="#FFD0D0"
327CELLSPACING="0"
328CELLPADDING="4"
329CLASS="CALSTABLE"
330><TR
331><TD
332WIDTH="20%"
333ALIGN="RIGHT"
334VALIGN="TOP"
335><TT
336CLASS="PARAMETER"
337><I
338>cur</I
339></TT
340>&nbsp;:</TD
341><TD
342WIDTH="80%"
343ALIGN="LEFT"
344VALIGN="TOP"
Daniel Veillard35008381999-10-25 13:15:52 +0000[diff] [blame^]345> the document</TD
Daniel Veillard1566d3a1999-07-15 14:24:29 +0000[diff] [blame]346></TR
347><TR
348><TD
349WIDTH="20%"
350ALIGN="RIGHT"
351VALIGN="TOP"
352><TT
353CLASS="PARAMETER"
354><I
355>mem</I
356></TT
357>&nbsp;:</TD
358><TD
359WIDTH="80%"
360ALIGN="LEFT"
361VALIGN="TOP"
Daniel Veillard35008381999-10-25 13:15:52 +0000[diff] [blame^]362> OUT: the memory pointer</TD
Daniel Veillard1566d3a1999-07-15 14:24:29 +0000[diff] [blame]363></TR
364><TR
365><TD
366WIDTH="20%"
367ALIGN="RIGHT"
368VALIGN="TOP"
369><TT
370CLASS="PARAMETER"
371><I
372>size</I
373></TT
374>&nbsp;:</TD
375><TD
376WIDTH="80%"
377ALIGN="LEFT"
378VALIGN="TOP"
Daniel Veillard35008381999-10-25 13:15:52 +0000[diff] [blame^]379> OUT: the memory lenght</TD
Daniel Veillard1566d3a1999-07-15 14:24:29 +0000[diff] [blame]380></TR
381></TABLE
382><P
383></P
384></DIV
385></DIV
386><HR><DIV
387CLASS="REFSECT2"
388><A
Daniel Veillard35008381999-10-25 13:15:52 +0000[diff] [blame^]389NAME="AEN6690"
Daniel Veillard1566d3a1999-07-15 14:24:29 +0000[diff] [blame]390></A
391><H3
392><A
393NAME="HTMLDOCDUMP"
394></A
395>htmlDocDump ()</H3
396><TABLE
397BORDER="0"
398BGCOLOR="#D6E8FF"
399WIDTH="100%"
400CELLPADDING="6"
401><TR
402><TD
403><PRE
404CLASS="PROGRAMLISTING"
405>void htmlDocDump (<GTKDOCLINK
406HREF="FILE"
407>FILE</GTKDOCLINK
408> *f,
409 <A
410HREF="gnome-xml-tree.html#XMLDOCPTR"
411>xmlDocPtr</A
412> cur);</PRE
413></TD
414></TR
415></TABLE
416><P
417>Dump an HTML document to an open FILE.</P
418><P
419></P
420><DIV
421CLASS="INFORMALTABLE"
422><P
423></P
424><TABLE
425BORDER="0"
426WIDTH="100%"
427BGCOLOR="#FFD0D0"
428CELLSPACING="0"
429CELLPADDING="4"
430CLASS="CALSTABLE"
431><TR
432><TD
433WIDTH="20%"
434ALIGN="RIGHT"
435VALIGN="TOP"
436><TT
437CLASS="PARAMETER"
438><I
439>f</I
440></TT
441>&nbsp;:</TD
442><TD
443WIDTH="80%"
444ALIGN="LEFT"
445VALIGN="TOP"
Daniel Veillard35008381999-10-25 13:15:52 +0000[diff] [blame^]446> the FILE*</TD
Daniel Veillard1566d3a1999-07-15 14:24:29 +0000[diff] [blame]447></TR
448><TR
449><TD
450WIDTH="20%"
451ALIGN="RIGHT"
452VALIGN="TOP"
453><TT
454CLASS="PARAMETER"
455><I
456>cur</I
457></TT
458>&nbsp;:</TD
459><TD
460WIDTH="80%"
461ALIGN="LEFT"
462VALIGN="TOP"
Daniel Veillard35008381999-10-25 13:15:52 +0000[diff] [blame^]463> the document</TD
Daniel Veillard1566d3a1999-07-15 14:24:29 +0000[diff] [blame]464></TR
465></TABLE
466><P
467></P
468></DIV
469></DIV
470><HR><DIV
471CLASS="REFSECT2"
472><A
Daniel Veillard35008381999-10-25 13:15:52 +0000[diff] [blame^]473NAME="AEN6711"
Daniel Veillard1566d3a1999-07-15 14:24:29 +0000[diff] [blame]474></A
475><H3
476><A
477NAME="HTMLSAVEFILE"
478></A
479>htmlSaveFile ()</H3
480><TABLE
481BORDER="0"
482BGCOLOR="#D6E8FF"
483WIDTH="100%"
484CELLPADDING="6"
485><TR
486><TD
487><PRE
488CLASS="PROGRAMLISTING"
489>int htmlSaveFile (const char *filename,
490 <A
491HREF="gnome-xml-tree.html#XMLDOCPTR"
492>xmlDocPtr</A
493> cur);</PRE
494></TD
495></TR
496></TABLE
497><P
498>Dump an HTML document to a file.</P
499><P
500></P
501><DIV
502CLASS="INFORMALTABLE"
503><P
504></P
505><TABLE
506BORDER="0"
507WIDTH="100%"
508BGCOLOR="#FFD0D0"
509CELLSPACING="0"
510CELLPADDING="4"
511CLASS="CALSTABLE"
512><TR
513><TD
514WIDTH="20%"
515ALIGN="RIGHT"
516VALIGN="TOP"
517><TT
518CLASS="PARAMETER"
519><I
520>filename</I
521></TT
522>&nbsp;:</TD
523><TD
524WIDTH="80%"
525ALIGN="LEFT"
526VALIGN="TOP"
Daniel Veillard35008381999-10-25 13:15:52 +0000[diff] [blame^]527> the filename</TD
Daniel Veillard1566d3a1999-07-15 14:24:29 +0000[diff] [blame]528></TR
529><TR
530><TD
531WIDTH="20%"
532ALIGN="RIGHT"
533VALIGN="TOP"
534><TT
535CLASS="PARAMETER"
536><I
537>cur</I
538></TT
539>&nbsp;:</TD
540><TD
541WIDTH="80%"
542ALIGN="LEFT"
543VALIGN="TOP"
Daniel Veillard35008381999-10-25 13:15:52 +0000[diff] [blame^]544> the document</TD
Daniel Veillard1566d3a1999-07-15 14:24:29 +0000[diff] [blame]545></TR
546><TR
547><TD
548WIDTH="20%"
549ALIGN="RIGHT"
550VALIGN="TOP"
551><I
552CLASS="EMPHASIS"
553>Returns</I
554> :</TD
555><TD
556WIDTH="80%"
557ALIGN="LEFT"
558VALIGN="TOP"
Daniel Veillard35008381999-10-25 13:15:52 +0000[diff] [blame^]559> the number of byte written or -1 in case of failure.</TD
Daniel Veillard1566d3a1999-07-15 14:24:29 +0000[diff] [blame]560></TR
561></TABLE
562><P
563></P
564></DIV
565></DIV
566></DIV
567><DIV
568CLASS="NAVFOOTER"
Daniel Veillard00fdf371999-10-08 09:40:39 +0000[diff] [blame]569><BR
570CLEAR="all"><BR><TABLE
Daniel Veillard1566d3a1999-07-15 14:24:29 +0000[diff] [blame]571WIDTH="100%"
572BORDER="0"
573BGCOLOR="#000000"
574CELLPADDING="1"
575CELLSPACING="0"
576><TR
577><TD
578WIDTH="25%"
579BGCOLOR="#C00000"
580ALIGN="left"
581><A
582HREF="gnome-xml-htmlparser.html"
583><FONT
584COLOR="#FFFFFF"
585SIZE="3"
586><B
587>&#60;&#60;&#60; Previous Page</B
588></FONT
589></A
590></TD
591><TD
592WIDTH="25%"
593BGCOLOR="#0000C0"
594ALIGN="center"
595><FONT
596COLOR="#FFFFFF"
597SIZE="3"
598><B
599><A
600HREF="book1.html"
601><FONT
602COLOR="#FFFFFF"
603SIZE="3"
604><B
605>Home</B
606></FONT
607></A
608></B
609></FONT
610></TD
611><TD
612WIDTH="25%"
613BGCOLOR="#00C000"
614ALIGN="center"
615><FONT
616COLOR="#FFFFFF"
617SIZE="3"
618><B
619><A
Daniel Veillard35008381999-10-25 13:15:52 +0000[diff] [blame^]620HREF="libxml-lib.html"
Daniel Veillard1566d3a1999-07-15 14:24:29 +0000[diff] [blame]621><FONT
622COLOR="#FFFFFF"
623SIZE="3"
624><B
625>Up</B
626></FONT
627></A
628></B
629></FONT
630></TD
631><TD
632WIDTH="25%"
633BGCOLOR="#C00000"
634ALIGN="right"
635><A
636HREF="gnome-xml-xpath.html"
637><FONT
638COLOR="#FFFFFF"
639SIZE="3"
640><B
641>Next Page &#62;&#62;&#62;</B
642></FONT
643></A
644></TD
645></TR
646><TR
647><TD
648COLSPAN="2"
649ALIGN="left"
650><FONT
651COLOR="#FFFFFF"
652SIZE="3"
653><B
654>HTMLparser</B
655></FONT
656></TD
657><TD
658COLSPAN="2"
659ALIGN="right"
660><FONT
661COLOR="#FFFFFF"
662SIZE="3"
663><B
664>xpath</B
665></FONT
666></TD
667></TR
668></TABLE
669></DIV
670></BODY
671></HTML
672>