Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / libxml2 / 011b63cb2034476017dde1d4ad5a6aea43b94066 / . / doc / html / gnome-xml-entities.html
blob: 5f326a1680a8123f994d7c8c657a618d1659298c [file] [log] [blame]
Daniel Veillard35925471999-02-25 08:46:07 +0000[diff] [blame]1<HTML
2><HEAD
3><TITLE
4>entities</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"
12TITLE="Gnome XML Library"
13HREF="libxml.html"><LINK
14REL="PREVIOUS"
15TITLE="tree"
16HREF="gnome-xml-tree.html"><LINK
17REL="NEXT"
18TITLE="valid"
19HREF="gnome-xml-valid.html"></HEAD
20><BODY
21BGCOLOR="#FFFFFF"
22TEXT="#000000"
23><DIV
24CLASS="NAVHEADER"
25><TABLE
26WIDTH="100%"
27BORDER="0"
28CELLPADDING="0"
29CELLSPACING="0"
30><TR
31><TH
32COLSPAN="3"
33ALIGN="center"
34>Gnome XML Library Reference Manual</TH
35></TR
36><TR
37><TD
38WIDTH="10%"
39ALIGN="left"
40VALIGN="bottom"
41><A
42HREF="gnome-xml-tree.html"
43>Prev</A
44></TD
45><TD
46WIDTH="80%"
47ALIGN="center"
48VALIGN="bottom"
49></TD
50><TD
51WIDTH="10%"
52ALIGN="right"
53VALIGN="bottom"
54><A
55HREF="gnome-xml-valid.html"
56>Next</A
57></TD
58></TR
59></TABLE
60><HR
61ALIGN="LEFT"
62WIDTH="100%"></DIV
63><H1
64>entities</H1
65><DIV
66CLASS="REFNAMEDIV"
67><A
Daniel Veillard011b63c1999-06-02 17:44:04 +0000[diff] [blame^]68NAME="AEN3492"
Daniel Veillard35925471999-02-25 08:46:07 +0000[diff] [blame]69></A
70><H2
71>Name</H2
72>entities &#8212; one line description goes here.</DIV
73><DIV
74CLASS="REFSYNOPSISDIV"
75><A
Daniel Veillard011b63c1999-06-02 17:44:04 +0000[diff] [blame^]76NAME="AEN3495"
Daniel Veillard35925471999-02-25 08:46:07 +0000[diff] [blame]77></A
78><H2
79>Synopsis</H2
80><TABLE
81BORDER="0"
82BGCOLOR="#E8E8F8"
83WIDTH="100%"
84CELLPADDING="6"
85><TR
86><TD
87><PRE
88CLASS="SYNOPSIS"
89>&#13;
90
91#define <A
92HREF="gnome-xml-entities.html#XML-INTERNAL-GENERAL-ENTITY"
93>XML_INTERNAL_GENERAL_ENTITY</A
94>
95#define <A
96HREF="gnome-xml-entities.html#XML-EXTERNAL-GENERAL-PARSED-ENTITY"
97>XML_EXTERNAL_GENERAL_PARSED_ENTITY</A
98>
99#define <A
100HREF="gnome-xml-entities.html#XML-EXTERNAL-GENERAL-UNPARSED-ENTITY"
101>XML_EXTERNAL_GENERAL_UNPARSED_ENTITY</A
102>
103#define <A
104HREF="gnome-xml-entities.html#XML-INTERNAL-PARAMETER-ENTITY"
105>XML_INTERNAL_PARAMETER_ENTITY</A
106>
107#define <A
108HREF="gnome-xml-entities.html#XML-EXTERNAL-PARAMETER-ENTITY"
109>XML_EXTERNAL_PARAMETER_ENTITY</A
110>
111#define <A
112HREF="gnome-xml-entities.html#XML-INTERNAL-PREDEFINED-ENTITY"
113>XML_INTERNAL_PREDEFINED_ENTITY</A
114>
115typedef <A
116HREF="gnome-xml-entities.html#XMLENTITYPTR"
117>xmlEntityPtr</A
118>
119#define <A
120HREF="gnome-xml-entities.html#XML-MIN-ENTITIES-TABLE"
121>XML_MIN_ENTITIES_TABLE</A
122>
123typedef <A
124HREF="gnome-xml-entities.html#XMLENTITIESTABLEPTR"
125>xmlEntitiesTablePtr</A
126>
127void <A
128HREF="gnome-xml-entities.html#XMLADDDOCENTITY"
129>xmlAddDocEntity</A
130> (<A
131HREF="gnome-xml-tree.html#XMLDOCPTR"
132>xmlDocPtr</A
133> doc,
134 const <A
135HREF="gnome-xml-tree.html#CHAR"
136>CHAR</A
137> *name,
138 int type,
139 const <A
140HREF="gnome-xml-tree.html#CHAR"
141>CHAR</A
142> *ExternalID,
143 const <A
144HREF="gnome-xml-tree.html#CHAR"
145>CHAR</A
146> *SystemID,
147 <A
148HREF="gnome-xml-tree.html#CHAR"
149>CHAR</A
150> *content);
151void <A
152HREF="gnome-xml-entities.html#XMLADDDTDENTITY"
153>xmlAddDtdEntity</A
154> (<A
155HREF="gnome-xml-tree.html#XMLDOCPTR"
156>xmlDocPtr</A
157> doc,
158 const <A
159HREF="gnome-xml-tree.html#CHAR"
160>CHAR</A
161> *name,
162 int type,
163 const <A
164HREF="gnome-xml-tree.html#CHAR"
165>CHAR</A
166> *ExternalID,
167 const <A
168HREF="gnome-xml-tree.html#CHAR"
169>CHAR</A
170> *SystemID,
171 <A
172HREF="gnome-xml-tree.html#CHAR"
173>CHAR</A
174> *content);
175<A
176HREF="gnome-xml-entities.html#XMLENTITYPTR"
177>xmlEntityPtr</A
178> <A
179HREF="gnome-xml-entities.html#XMLGETPREDEFINEDENTITY"
180>xmlGetPredefinedEntity</A
181> (const <A
182HREF="gnome-xml-tree.html#CHAR"
183>CHAR</A
184> *name);
185<A
186HREF="gnome-xml-entities.html#XMLENTITYPTR"
187>xmlEntityPtr</A
188> <A
189HREF="gnome-xml-entities.html#XMLGETDOCENTITY"
190>xmlGetDocEntity</A
191> (<A
192HREF="gnome-xml-tree.html#XMLDOCPTR"
193>xmlDocPtr</A
194> doc,
195 const <A
196HREF="gnome-xml-tree.html#CHAR"
197>CHAR</A
198> *name);
199<A
200HREF="gnome-xml-entities.html#XMLENTITYPTR"
201>xmlEntityPtr</A
202> <A
203HREF="gnome-xml-entities.html#XMLGETDTDENTITY"
204>xmlGetDtdEntity</A
205> (<A
206HREF="gnome-xml-tree.html#XMLDOCPTR"
207>xmlDocPtr</A
208> doc,
209 const <A
210HREF="gnome-xml-tree.html#CHAR"
211>CHAR</A
212> *name);
213<A
214HREF="gnome-xml-tree.html#CHAR"
215>CHAR</A
216>* <A
217HREF="gnome-xml-entities.html#XMLENCODEENTITIES"
218>xmlEncodeEntities</A
219> (<A
220HREF="gnome-xml-tree.html#XMLDOCPTR"
221>xmlDocPtr</A
222> doc,
223 const <A
224HREF="gnome-xml-tree.html#CHAR"
225>CHAR</A
226> *input);
227<A
228HREF="gnome-xml-entities.html#XMLENTITIESTABLEPTR"
229>xmlEntitiesTablePtr</A
230> <A
231HREF="gnome-xml-entities.html#XMLCREATEENTITIESTABLE"
232>xmlCreateEntitiesTable</A
233> (void);
234<A
235HREF="gnome-xml-entities.html#XMLENTITIESTABLEPTR"
236>xmlEntitiesTablePtr</A
237> <A
238HREF="gnome-xml-entities.html#XMLCOPYENTITIESTABLE"
239>xmlCopyEntitiesTable</A
240> (<A
241HREF="gnome-xml-entities.html#XMLENTITIESTABLEPTR"
242>xmlEntitiesTablePtr</A
243> table);
244void <A
245HREF="gnome-xml-entities.html#XMLFREEENTITIESTABLE"
246>xmlFreeEntitiesTable</A
247> (<A
248HREF="gnome-xml-entities.html#XMLENTITIESTABLEPTR"
249>xmlEntitiesTablePtr</A
250> table);
251void <A
252HREF="gnome-xml-entities.html#XMLDUMPENTITIESTABLE"
253>xmlDumpEntitiesTable</A
254> (<A
Daniel Veillard5099ae81999-04-21 20:12:07 +0000[diff] [blame]255HREF="gnome-xml-tree.html#XMLBUFFERPTR"
256>xmlBufferPtr</A
257> buf,
258 <A
Daniel Veillard35925471999-02-25 08:46:07 +0000[diff] [blame]259HREF="gnome-xml-entities.html#XMLENTITIESTABLEPTR"
260>xmlEntitiesTablePtr</A
Daniel Veillard011b63c1999-06-02 17:44:04 +0000[diff] [blame^]261> table);</PRE
Daniel Veillard35925471999-02-25 08:46:07 +0000[diff] [blame]262></TD
263></TR
264></TABLE
265></DIV
266><DIV
267CLASS="REFSECT1"
268><A
Daniel Veillard011b63c1999-06-02 17:44:04 +0000[diff] [blame^]269NAME="AEN3544"
Daniel Veillard35925471999-02-25 08:46:07 +0000[diff] [blame]270></A
271><H2
272>Description</H2
273><P
274></P
275></DIV
276><DIV
277CLASS="REFSECT1"
278><A
Daniel Veillard011b63c1999-06-02 17:44:04 +0000[diff] [blame^]279NAME="AEN3547"
Daniel Veillard35925471999-02-25 08:46:07 +0000[diff] [blame]280></A
281><H2
282>Details</H2
283><HR><DIV
284CLASS="REFSECT2"
285><A
Daniel Veillard011b63c1999-06-02 17:44:04 +0000[diff] [blame^]286NAME="AEN3549"
Daniel Veillard35925471999-02-25 08:46:07 +0000[diff] [blame]287></A
288><H3
289><A
290NAME="XML-INTERNAL-GENERAL-ENTITY"
291></A
292>XML_INTERNAL_GENERAL_ENTITY</H3
293><TABLE
294BORDER="0"
295BGCOLOR="#E8E8F8"
296WIDTH="100%"
297CELLPADDING="6"
298><TR
299><TD
300><PRE
301CLASS="PROGRAMLISTING"
302>#define XML_INTERNAL_GENERAL_ENTITY 1</PRE
303></TD
304></TR
305></TABLE
306><P
307></P
308></DIV
309><HR><DIV
310CLASS="REFSECT2"
311><A
Daniel Veillard011b63c1999-06-02 17:44:04 +0000[diff] [blame^]312NAME="AEN3554"
Daniel Veillard35925471999-02-25 08:46:07 +0000[diff] [blame]313></A
314><H3
315><A
316NAME="XML-EXTERNAL-GENERAL-PARSED-ENTITY"
317></A
318>XML_EXTERNAL_GENERAL_PARSED_ENTITY</H3
319><TABLE
320BORDER="0"
321BGCOLOR="#E8E8F8"
322WIDTH="100%"
323CELLPADDING="6"
324><TR
325><TD
326><PRE
327CLASS="PROGRAMLISTING"
328>#define XML_EXTERNAL_GENERAL_PARSED_ENTITY 2</PRE
329></TD
330></TR
331></TABLE
332><P
333></P
334></DIV
335><HR><DIV
336CLASS="REFSECT2"
337><A
Daniel Veillard011b63c1999-06-02 17:44:04 +0000[diff] [blame^]338NAME="AEN3559"
Daniel Veillard35925471999-02-25 08:46:07 +0000[diff] [blame]339></A
340><H3
341><A
342NAME="XML-EXTERNAL-GENERAL-UNPARSED-ENTITY"
343></A
344>XML_EXTERNAL_GENERAL_UNPARSED_ENTITY</H3
345><TABLE
346BORDER="0"
347BGCOLOR="#E8E8F8"
348WIDTH="100%"
349CELLPADDING="6"
350><TR
351><TD
352><PRE
353CLASS="PROGRAMLISTING"
354>#define XML_EXTERNAL_GENERAL_UNPARSED_ENTITY 3</PRE
355></TD
356></TR
357></TABLE
358><P
359></P
360></DIV
361><HR><DIV
362CLASS="REFSECT2"
363><A
Daniel Veillard011b63c1999-06-02 17:44:04 +0000[diff] [blame^]364NAME="AEN3564"
Daniel Veillard35925471999-02-25 08:46:07 +0000[diff] [blame]365></A
366><H3
367><A
368NAME="XML-INTERNAL-PARAMETER-ENTITY"
369></A
370>XML_INTERNAL_PARAMETER_ENTITY</H3
371><TABLE
372BORDER="0"
373BGCOLOR="#E8E8F8"
374WIDTH="100%"
375CELLPADDING="6"
376><TR
377><TD
378><PRE
379CLASS="PROGRAMLISTING"
380>#define XML_INTERNAL_PARAMETER_ENTITY 4</PRE
381></TD
382></TR
383></TABLE
384><P
385></P
386></DIV
387><HR><DIV
388CLASS="REFSECT2"
389><A
Daniel Veillard011b63c1999-06-02 17:44:04 +0000[diff] [blame^]390NAME="AEN3569"
Daniel Veillard35925471999-02-25 08:46:07 +0000[diff] [blame]391></A
392><H3
393><A
394NAME="XML-EXTERNAL-PARAMETER-ENTITY"
395></A
396>XML_EXTERNAL_PARAMETER_ENTITY</H3
397><TABLE
398BORDER="0"
399BGCOLOR="#E8E8F8"
400WIDTH="100%"
401CELLPADDING="6"
402><TR
403><TD
404><PRE
405CLASS="PROGRAMLISTING"
406>#define XML_EXTERNAL_PARAMETER_ENTITY 5</PRE
407></TD
408></TR
409></TABLE
410><P
411></P
412></DIV
413><HR><DIV
414CLASS="REFSECT2"
415><A
Daniel Veillard011b63c1999-06-02 17:44:04 +0000[diff] [blame^]416NAME="AEN3574"
Daniel Veillard35925471999-02-25 08:46:07 +0000[diff] [blame]417></A
418><H3
419><A
420NAME="XML-INTERNAL-PREDEFINED-ENTITY"
421></A
422>XML_INTERNAL_PREDEFINED_ENTITY</H3
423><TABLE
424BORDER="0"
425BGCOLOR="#E8E8F8"
426WIDTH="100%"
427CELLPADDING="6"
428><TR
429><TD
430><PRE
431CLASS="PROGRAMLISTING"
432>#define XML_INTERNAL_PREDEFINED_ENTITY 6</PRE
433></TD
434></TR
435></TABLE
436><P
437></P
438></DIV
439><HR><DIV
440CLASS="REFSECT2"
441><A
Daniel Veillard011b63c1999-06-02 17:44:04 +0000[diff] [blame^]442NAME="AEN3579"
Daniel Veillard35925471999-02-25 08:46:07 +0000[diff] [blame]443></A
444><H3
445><A
446NAME="XMLENTITYPTR"
447></A
448>xmlEntityPtr</H3
449><TABLE
450BORDER="0"
451BGCOLOR="#E8E8F8"
452WIDTH="100%"
453CELLPADDING="6"
454><TR
455><TD
456><PRE
457CLASS="PROGRAMLISTING"
458>typedef xmlEntity *xmlEntityPtr;</PRE
459></TD
460></TR
461></TABLE
462><P
463></P
464></DIV
465><HR><DIV
466CLASS="REFSECT2"
467><A
Daniel Veillard011b63c1999-06-02 17:44:04 +0000[diff] [blame^]468NAME="AEN3584"
Daniel Veillard35925471999-02-25 08:46:07 +0000[diff] [blame]469></A
470><H3
471><A
472NAME="XML-MIN-ENTITIES-TABLE"
473></A
474>XML_MIN_ENTITIES_TABLE</H3
475><TABLE
476BORDER="0"
477BGCOLOR="#E8E8F8"
478WIDTH="100%"
479CELLPADDING="6"
480><TR
481><TD
482><PRE
483CLASS="PROGRAMLISTING"
484>#define XML_MIN_ENTITIES_TABLE 32</PRE
485></TD
486></TR
487></TABLE
488><P
489></P
490></DIV
491><HR><DIV
492CLASS="REFSECT2"
493><A
Daniel Veillard011b63c1999-06-02 17:44:04 +0000[diff] [blame^]494NAME="AEN3589"
Daniel Veillard35925471999-02-25 08:46:07 +0000[diff] [blame]495></A
496><H3
497><A
498NAME="XMLENTITIESTABLEPTR"
499></A
500>xmlEntitiesTablePtr</H3
501><TABLE
502BORDER="0"
503BGCOLOR="#E8E8F8"
504WIDTH="100%"
505CELLPADDING="6"
506><TR
507><TD
508><PRE
509CLASS="PROGRAMLISTING"
510>typedef xmlEntitiesTable *xmlEntitiesTablePtr;</PRE
511></TD
512></TR
513></TABLE
514><P
515></P
516></DIV
517><HR><DIV
518CLASS="REFSECT2"
519><A
Daniel Veillard011b63c1999-06-02 17:44:04 +0000[diff] [blame^]520NAME="AEN3594"
Daniel Veillard35925471999-02-25 08:46:07 +0000[diff] [blame]521></A
522><H3
523><A
524NAME="XMLADDDOCENTITY"
525></A
526>xmlAddDocEntity()</H3
527><TABLE
528BORDER="0"
529BGCOLOR="#E8E8F8"
530WIDTH="100%"
531CELLPADDING="6"
532><TR
533><TD
534><PRE
535CLASS="PROGRAMLISTING"
536>void xmlAddDocEntity (<A
537HREF="gnome-xml-tree.html#XMLDOCPTR"
538>xmlDocPtr</A
539> doc,
540 const <A
541HREF="gnome-xml-tree.html#CHAR"
542>CHAR</A
543> *name,
544 int type,
545 const <A
546HREF="gnome-xml-tree.html#CHAR"
547>CHAR</A
548> *ExternalID,
549 const <A
550HREF="gnome-xml-tree.html#CHAR"
551>CHAR</A
552> *SystemID,
553 <A
554HREF="gnome-xml-tree.html#CHAR"
555>CHAR</A
556> *content);</PRE
557></TD
558></TR
559></TABLE
560><P
561>Register a new entity for this document.</P
562><P
563></P
564><DIV
565CLASS="INFORMALTABLE"
566><P
567></P
568><TABLE
569BORDER="0"
570WIDTH="100%"
571BGCOLOR="#FFE0E0"
572CELLSPACING="0"
573CELLPADDING="4"
574CLASS="CALSTABLE"
575><TR
576><TD
577WIDTH="20%"
578ALIGN="RIGHT"
579VALIGN="TOP"
580><TT
581CLASS="PARAMETER"
582><I
583>doc</I
584></TT
585>&nbsp;:</TD
586><TD
587WIDTH="80%"
588ALIGN="LEFT"
589VALIGN="TOP"
590> the document</TD
591></TR
592><TR
593><TD
594WIDTH="20%"
595ALIGN="RIGHT"
596VALIGN="TOP"
597><TT
598CLASS="PARAMETER"
599><I
600>name</I
601></TT
602>&nbsp;:</TD
603><TD
604WIDTH="80%"
605ALIGN="LEFT"
606VALIGN="TOP"
607> the entity name</TD
608></TR
609><TR
610><TD
611WIDTH="20%"
612ALIGN="RIGHT"
613VALIGN="TOP"
614><TT
615CLASS="PARAMETER"
616><I
617>type</I
618></TT
619>&nbsp;:</TD
620><TD
621WIDTH="80%"
622ALIGN="LEFT"
623VALIGN="TOP"
624> the entity type XML_xxx_yyy_ENTITY</TD
625></TR
626><TR
627><TD
628WIDTH="20%"
629ALIGN="RIGHT"
630VALIGN="TOP"
631><TT
632CLASS="PARAMETER"
633><I
634>ExternalID</I
635></TT
636>&nbsp;:</TD
637><TD
638WIDTH="80%"
639ALIGN="LEFT"
640VALIGN="TOP"
641> the entity external ID if available</TD
642></TR
643><TR
644><TD
645WIDTH="20%"
646ALIGN="RIGHT"
647VALIGN="TOP"
648><TT
649CLASS="PARAMETER"
650><I
651>SystemID</I
652></TT
653>&nbsp;:</TD
654><TD
655WIDTH="80%"
656ALIGN="LEFT"
657VALIGN="TOP"
658> the entity system ID if available</TD
659></TR
660><TR
661><TD
662WIDTH="20%"
663ALIGN="RIGHT"
664VALIGN="TOP"
665><TT
666CLASS="PARAMETER"
667><I
668>content</I
669></TT
670>&nbsp;:</TD
671><TD
672WIDTH="80%"
673ALIGN="LEFT"
674VALIGN="TOP"
675> the entity content</TD
676></TR
677></TABLE
678><P
679></P
680></DIV
681></DIV
682><HR><DIV
683CLASS="REFSECT2"
684><A
Daniel Veillard011b63c1999-06-02 17:44:04 +0000[diff] [blame^]685NAME="AEN3634"
Daniel Veillard35925471999-02-25 08:46:07 +0000[diff] [blame]686></A
687><H3
688><A
689NAME="XMLADDDTDENTITY"
690></A
691>xmlAddDtdEntity()</H3
692><TABLE
693BORDER="0"
694BGCOLOR="#E8E8F8"
695WIDTH="100%"
696CELLPADDING="6"
697><TR
698><TD
699><PRE
700CLASS="PROGRAMLISTING"
701>void xmlAddDtdEntity (<A
702HREF="gnome-xml-tree.html#XMLDOCPTR"
703>xmlDocPtr</A
704> doc,
705 const <A
706HREF="gnome-xml-tree.html#CHAR"
707>CHAR</A
708> *name,
709 int type,
710 const <A
711HREF="gnome-xml-tree.html#CHAR"
712>CHAR</A
713> *ExternalID,
714 const <A
715HREF="gnome-xml-tree.html#CHAR"
716>CHAR</A
717> *SystemID,
718 <A
719HREF="gnome-xml-tree.html#CHAR"
720>CHAR</A
721> *content);</PRE
722></TD
723></TR
724></TABLE
725><P
726>Register a new entity for this document DTD.</P
727><P
728></P
729><DIV
730CLASS="INFORMALTABLE"
731><P
732></P
733><TABLE
734BORDER="0"
735WIDTH="100%"
736BGCOLOR="#FFE0E0"
737CELLSPACING="0"
738CELLPADDING="4"
739CLASS="CALSTABLE"
740><TR
741><TD
742WIDTH="20%"
743ALIGN="RIGHT"
744VALIGN="TOP"
745><TT
746CLASS="PARAMETER"
747><I
748>doc</I
749></TT
750>&nbsp;:</TD
751><TD
752WIDTH="80%"
753ALIGN="LEFT"
754VALIGN="TOP"
755> the document</TD
756></TR
757><TR
758><TD
759WIDTH="20%"
760ALIGN="RIGHT"
761VALIGN="TOP"
762><TT
763CLASS="PARAMETER"
764><I
765>name</I
766></TT
767>&nbsp;:</TD
768><TD
769WIDTH="80%"
770ALIGN="LEFT"
771VALIGN="TOP"
772> the entity name</TD
773></TR
774><TR
775><TD
776WIDTH="20%"
777ALIGN="RIGHT"
778VALIGN="TOP"
779><TT
780CLASS="PARAMETER"
781><I
782>type</I
783></TT
784>&nbsp;:</TD
785><TD
786WIDTH="80%"
787ALIGN="LEFT"
788VALIGN="TOP"
789> the entity type XML_xxx_yyy_ENTITY</TD
790></TR
791><TR
792><TD
793WIDTH="20%"
794ALIGN="RIGHT"
795VALIGN="TOP"
796><TT
797CLASS="PARAMETER"
798><I
799>ExternalID</I
800></TT
801>&nbsp;:</TD
802><TD
803WIDTH="80%"
804ALIGN="LEFT"
805VALIGN="TOP"
806> the entity external ID if available</TD
807></TR
808><TR
809><TD
810WIDTH="20%"
811ALIGN="RIGHT"
812VALIGN="TOP"
813><TT
814CLASS="PARAMETER"
815><I
816>SystemID</I
817></TT
818>&nbsp;:</TD
819><TD
820WIDTH="80%"
821ALIGN="LEFT"
822VALIGN="TOP"
823> the entity system ID if available</TD
824></TR
825><TR
826><TD
827WIDTH="20%"
828ALIGN="RIGHT"
829VALIGN="TOP"
830><TT
831CLASS="PARAMETER"
832><I
833>content</I
834></TT
835>&nbsp;:</TD
836><TD
837WIDTH="80%"
838ALIGN="LEFT"
839VALIGN="TOP"
840> the entity content</TD
841></TR
842></TABLE
843><P
844></P
845></DIV
846></DIV
847><HR><DIV
848CLASS="REFSECT2"
849><A
Daniel Veillard011b63c1999-06-02 17:44:04 +0000[diff] [blame^]850NAME="AEN3674"
Daniel Veillard35925471999-02-25 08:46:07 +0000[diff] [blame]851></A
852><H3
853><A
854NAME="XMLGETPREDEFINEDENTITY"
855></A
856>xmlGetPredefinedEntity()</H3
857><TABLE
858BORDER="0"
859BGCOLOR="#E8E8F8"
860WIDTH="100%"
861CELLPADDING="6"
862><TR
863><TD
864><PRE
865CLASS="PROGRAMLISTING"
866><A
867HREF="gnome-xml-entities.html#XMLENTITYPTR"
868>xmlEntityPtr</A
869> xmlGetPredefinedEntity (const <A
870HREF="gnome-xml-tree.html#CHAR"
871>CHAR</A
872> *name);</PRE
873></TD
874></TR
875></TABLE
876><P
877>Check whether this name is an predefined entity.</P
878><P
879></P
880><DIV
881CLASS="INFORMALTABLE"
882><P
883></P
884><TABLE
885BORDER="0"
886WIDTH="100%"
887BGCOLOR="#FFE0E0"
888CELLSPACING="0"
889CELLPADDING="4"
890CLASS="CALSTABLE"
891><TR
892><TD
893WIDTH="20%"
894ALIGN="RIGHT"
895VALIGN="TOP"
896><TT
897CLASS="PARAMETER"
898><I
899>name</I
900></TT
901>&nbsp;:</TD
902><TD
903WIDTH="80%"
904ALIGN="LEFT"
905VALIGN="TOP"
906> the entity name</TD
907></TR
908><TR
909><TD
910WIDTH="20%"
911ALIGN="RIGHT"
912VALIGN="TOP"
913><I
914CLASS="EMPHASIS"
915>Returns</I
916> :</TD
917><TD
918WIDTH="80%"
919ALIGN="LEFT"
920VALIGN="TOP"
921>NULL if not, othervise the entity</TD
922></TR
923></TABLE
924><P
925></P
926></DIV
927></DIV
928><HR><DIV
929CLASS="REFSECT2"
930><A
Daniel Veillard011b63c1999-06-02 17:44:04 +0000[diff] [blame^]931NAME="AEN3695"
Daniel Veillard35925471999-02-25 08:46:07 +0000[diff] [blame]932></A
933><H3
934><A
935NAME="XMLGETDOCENTITY"
936></A
937>xmlGetDocEntity()</H3
938><TABLE
939BORDER="0"
940BGCOLOR="#E8E8F8"
941WIDTH="100%"
942CELLPADDING="6"
943><TR
944><TD
945><PRE
946CLASS="PROGRAMLISTING"
947><A
948HREF="gnome-xml-entities.html#XMLENTITYPTR"
949>xmlEntityPtr</A
950> xmlGetDocEntity (<A
951HREF="gnome-xml-tree.html#XMLDOCPTR"
952>xmlDocPtr</A
953> doc,
954 const <A
955HREF="gnome-xml-tree.html#CHAR"
956>CHAR</A
957> *name);</PRE
958></TD
959></TR
960></TABLE
961><P
962>Do an entity lookup in the document entity hash table and
963returns the corrsponding entity, otherwise a lookup is done
964in the predefined entities too.</P
965><P
966></P
967><DIV
968CLASS="INFORMALTABLE"
969><P
970></P
971><TABLE
972BORDER="0"
973WIDTH="100%"
974BGCOLOR="#FFE0E0"
975CELLSPACING="0"
976CELLPADDING="4"
977CLASS="CALSTABLE"
978><TR
979><TD
980WIDTH="20%"
981ALIGN="RIGHT"
982VALIGN="TOP"
983><TT
984CLASS="PARAMETER"
985><I
986>doc</I
987></TT
988>&nbsp;:</TD
989><TD
990WIDTH="80%"
991ALIGN="LEFT"
992VALIGN="TOP"
993> the document referencing the entity</TD
994></TR
995><TR
996><TD
997WIDTH="20%"
998ALIGN="RIGHT"
999VALIGN="TOP"
1000><TT
1001CLASS="PARAMETER"
1002><I
1003>name</I
1004></TT
1005>&nbsp;:</TD
1006><TD
1007WIDTH="80%"
1008ALIGN="LEFT"
1009VALIGN="TOP"
1010> the entity name</TD
1011></TR
1012><TR
1013><TD
1014WIDTH="20%"
1015ALIGN="RIGHT"
1016VALIGN="TOP"
1017><I
1018CLASS="EMPHASIS"
1019>Returns</I
1020> :</TD
1021><TD
1022WIDTH="80%"
1023ALIGN="LEFT"
1024VALIGN="TOP"
1025>A pointer to the entity structure or NULL if not found.</TD
1026></TR
1027></TABLE
1028><P
1029></P
1030></DIV
1031></DIV
1032><HR><DIV
1033CLASS="REFSECT2"
1034><A
Daniel Veillard011b63c1999-06-02 17:44:04 +0000[diff] [blame^]1035NAME="AEN3721"
Daniel Veillard35925471999-02-25 08:46:07 +0000[diff] [blame]1036></A
1037><H3
1038><A
1039NAME="XMLGETDTDENTITY"
1040></A
1041>xmlGetDtdEntity()</H3
1042><TABLE
1043BORDER="0"
1044BGCOLOR="#E8E8F8"
1045WIDTH="100%"
1046CELLPADDING="6"
1047><TR
1048><TD
1049><PRE
1050CLASS="PROGRAMLISTING"
1051><A
1052HREF="gnome-xml-entities.html#XMLENTITYPTR"
1053>xmlEntityPtr</A
1054> xmlGetDtdEntity (<A
1055HREF="gnome-xml-tree.html#XMLDOCPTR"
1056>xmlDocPtr</A
1057> doc,
1058 const <A
1059HREF="gnome-xml-tree.html#CHAR"
1060>CHAR</A
1061> *name);</PRE
1062></TD
1063></TR
1064></TABLE
1065><P
1066>Do an entity lookup in the Dtd entity hash table and
1067returns the corresponding entity, if found.</P
1068><P
1069></P
1070><DIV
1071CLASS="INFORMALTABLE"
1072><P
1073></P
1074><TABLE
1075BORDER="0"
1076WIDTH="100%"
1077BGCOLOR="#FFE0E0"
1078CELLSPACING="0"
1079CELLPADDING="4"
1080CLASS="CALSTABLE"
1081><TR
1082><TD
1083WIDTH="20%"
1084ALIGN="RIGHT"
1085VALIGN="TOP"
1086><TT
1087CLASS="PARAMETER"
1088><I
1089>doc</I
1090></TT
1091>&nbsp;:</TD
1092><TD
1093WIDTH="80%"
1094ALIGN="LEFT"
1095VALIGN="TOP"
1096> the document referencing the entity</TD
1097></TR
1098><TR
1099><TD
1100WIDTH="20%"
1101ALIGN="RIGHT"
1102VALIGN="TOP"
1103><TT
1104CLASS="PARAMETER"
1105><I
1106>name</I
1107></TT
1108>&nbsp;:</TD
1109><TD
1110WIDTH="80%"
1111ALIGN="LEFT"
1112VALIGN="TOP"
1113> the entity name</TD
1114></TR
1115><TR
1116><TD
1117WIDTH="20%"
1118ALIGN="RIGHT"
1119VALIGN="TOP"
1120><I
1121CLASS="EMPHASIS"
1122>Returns</I
1123> :</TD
1124><TD
1125WIDTH="80%"
1126ALIGN="LEFT"
1127VALIGN="TOP"
1128>A pointer to the entity structure or NULL if not found.</TD
1129></TR
1130></TABLE
1131><P
1132></P
1133></DIV
1134></DIV
1135><HR><DIV
1136CLASS="REFSECT2"
1137><A
Daniel Veillard011b63c1999-06-02 17:44:04 +0000[diff] [blame^]1138NAME="AEN3747"
Daniel Veillard35925471999-02-25 08:46:07 +0000[diff] [blame]1139></A
1140><H3
1141><A
1142NAME="XMLENCODEENTITIES"
1143></A
1144>xmlEncodeEntities()</H3
1145><TABLE
1146BORDER="0"
1147BGCOLOR="#E8E8F8"
1148WIDTH="100%"
1149CELLPADDING="6"
1150><TR
1151><TD
1152><PRE
1153CLASS="PROGRAMLISTING"
1154><A
1155HREF="gnome-xml-tree.html#CHAR"
1156>CHAR</A
1157>* xmlEncodeEntities (<A
1158HREF="gnome-xml-tree.html#XMLDOCPTR"
1159>xmlDocPtr</A
1160> doc,
1161 const <A
1162HREF="gnome-xml-tree.html#CHAR"
1163>CHAR</A
1164> *input);</PRE
1165></TD
1166></TR
1167></TABLE
1168><P
1169>Do a global encoding of a string, replacing the predefined entities
1170and non ASCII values with their entities and CharRef counterparts.</P
1171><P
1172>TODO !!!! Once moved to UTF-8 internal encoding, the encoding of non-ascii
1173get erroneous.</P
1174><P
Daniel Veillard35925471999-02-25 08:46:07 +0000[diff] [blame]1175></P
1176><DIV
1177CLASS="INFORMALTABLE"
1178><P
1179></P
1180><TABLE
1181BORDER="0"
1182WIDTH="100%"
1183BGCOLOR="#FFE0E0"
1184CELLSPACING="0"
1185CELLPADDING="4"
1186CLASS="CALSTABLE"
1187><TR
1188><TD
1189WIDTH="20%"
1190ALIGN="RIGHT"
1191VALIGN="TOP"
1192><TT
1193CLASS="PARAMETER"
1194><I
1195>doc</I
1196></TT
1197>&nbsp;:</TD
1198><TD
1199WIDTH="80%"
1200ALIGN="LEFT"
1201VALIGN="TOP"
1202> the document containing the string</TD
1203></TR
1204><TR
1205><TD
1206WIDTH="20%"
1207ALIGN="RIGHT"
1208VALIGN="TOP"
1209><TT
1210CLASS="PARAMETER"
1211><I
1212>input</I
1213></TT
1214>&nbsp;:</TD
1215><TD
1216WIDTH="80%"
1217ALIGN="LEFT"
1218VALIGN="TOP"
1219> A string to convert to XML.</TD
1220></TR
1221><TR
1222><TD
1223WIDTH="20%"
1224ALIGN="RIGHT"
1225VALIGN="TOP"
1226><I
1227CLASS="EMPHASIS"
1228>Returns</I
1229> :</TD
1230><TD
1231WIDTH="80%"
1232ALIGN="LEFT"
1233VALIGN="TOP"
1234>A newly allocated string with the substitution done.</TD
1235></TR
1236></TABLE
1237><P
1238></P
1239></DIV
1240></DIV
1241><HR><DIV
1242CLASS="REFSECT2"
1243><A
Daniel Veillard011b63c1999-06-02 17:44:04 +0000[diff] [blame^]1244NAME="AEN3774"
Daniel Veillard35925471999-02-25 08:46:07 +0000[diff] [blame]1245></A
1246><H3
1247><A
1248NAME="XMLCREATEENTITIESTABLE"
1249></A
1250>xmlCreateEntitiesTable()</H3
1251><TABLE
1252BORDER="0"
1253BGCOLOR="#E8E8F8"
1254WIDTH="100%"
1255CELLPADDING="6"
1256><TR
1257><TD
1258><PRE
1259CLASS="PROGRAMLISTING"
1260><A
1261HREF="gnome-xml-entities.html#XMLENTITIESTABLEPTR"
1262>xmlEntitiesTablePtr</A
1263> xmlCreateEntitiesTable (void);</PRE
1264></TD
1265></TR
1266></TABLE
1267><P
1268>create and initialize an empty entities hash table.</P
1269><P
1270></P
1271><DIV
1272CLASS="INFORMALTABLE"
1273><P
1274></P
1275><TABLE
1276BORDER="0"
1277WIDTH="100%"
1278BGCOLOR="#FFE0E0"
1279CELLSPACING="0"
1280CELLPADDING="4"
1281CLASS="CALSTABLE"
1282><TR
1283><TD
1284WIDTH="20%"
1285ALIGN="RIGHT"
1286VALIGN="TOP"
1287><I
1288CLASS="EMPHASIS"
1289>Returns</I
1290> :</TD
1291><TD
1292WIDTH="80%"
1293ALIGN="LEFT"
1294VALIGN="TOP"
1295>the xmlEntitiesTablePtr just created or NULL in case of error.</TD
1296></TR
1297></TABLE
1298><P
1299></P
1300></DIV
1301></DIV
1302><HR><DIV
1303CLASS="REFSECT2"
1304><A
Daniel Veillard011b63c1999-06-02 17:44:04 +0000[diff] [blame^]1305NAME="AEN3790"
Daniel Veillard35925471999-02-25 08:46:07 +0000[diff] [blame]1306></A
1307><H3
1308><A
1309NAME="XMLCOPYENTITIESTABLE"
1310></A
1311>xmlCopyEntitiesTable()</H3
1312><TABLE
1313BORDER="0"
1314BGCOLOR="#E8E8F8"
1315WIDTH="100%"
1316CELLPADDING="6"
1317><TR
1318><TD
1319><PRE
1320CLASS="PROGRAMLISTING"
1321><A
1322HREF="gnome-xml-entities.html#XMLENTITIESTABLEPTR"
1323>xmlEntitiesTablePtr</A
1324> xmlCopyEntitiesTable (<A
1325HREF="gnome-xml-entities.html#XMLENTITIESTABLEPTR"
1326>xmlEntitiesTablePtr</A
1327> table);</PRE
1328></TD
1329></TR
1330></TABLE
1331><P
1332>Build a copy of an entity table.</P
1333><P
1334></P
1335><DIV
1336CLASS="INFORMALTABLE"
1337><P
1338></P
1339><TABLE
1340BORDER="0"
1341WIDTH="100%"
1342BGCOLOR="#FFE0E0"
1343CELLSPACING="0"
1344CELLPADDING="4"
1345CLASS="CALSTABLE"
1346><TR
1347><TD
1348WIDTH="20%"
1349ALIGN="RIGHT"
1350VALIGN="TOP"
1351><TT
1352CLASS="PARAMETER"
1353><I
1354>table</I
1355></TT
1356>&nbsp;:</TD
1357><TD
1358WIDTH="80%"
1359ALIGN="LEFT"
1360VALIGN="TOP"
1361> An entity table</TD
1362></TR
1363><TR
1364><TD
1365WIDTH="20%"
1366ALIGN="RIGHT"
1367VALIGN="TOP"
1368><I
1369CLASS="EMPHASIS"
1370>Returns</I
1371> :</TD
1372><TD
1373WIDTH="80%"
1374ALIGN="LEFT"
1375VALIGN="TOP"
1376>the new xmlEntitiesTablePtr or NULL in case of error.</TD
1377></TR
1378></TABLE
1379><P
1380></P
1381></DIV
1382></DIV
1383><HR><DIV
1384CLASS="REFSECT2"
1385><A
Daniel Veillard011b63c1999-06-02 17:44:04 +0000[diff] [blame^]1386NAME="AEN3811"
Daniel Veillard35925471999-02-25 08:46:07 +0000[diff] [blame]1387></A
1388><H3
1389><A
1390NAME="XMLFREEENTITIESTABLE"
1391></A
1392>xmlFreeEntitiesTable()</H3
1393><TABLE
1394BORDER="0"
1395BGCOLOR="#E8E8F8"
1396WIDTH="100%"
1397CELLPADDING="6"
1398><TR
1399><TD
1400><PRE
1401CLASS="PROGRAMLISTING"
1402>void xmlFreeEntitiesTable (<A
1403HREF="gnome-xml-entities.html#XMLENTITIESTABLEPTR"
1404>xmlEntitiesTablePtr</A
1405> table);</PRE
1406></TD
1407></TR
1408></TABLE
1409><P
1410>Deallocate the memory used by an entities hash table.</P
1411><P
1412></P
1413><DIV
1414CLASS="INFORMALTABLE"
1415><P
1416></P
1417><TABLE
1418BORDER="0"
1419WIDTH="100%"
1420BGCOLOR="#FFE0E0"
1421CELLSPACING="0"
1422CELLPADDING="4"
1423CLASS="CALSTABLE"
1424><TR
1425><TD
1426WIDTH="20%"
1427ALIGN="RIGHT"
1428VALIGN="TOP"
1429><TT
1430CLASS="PARAMETER"
1431><I
1432>table</I
1433></TT
1434>&nbsp;:</TD
1435><TD
1436WIDTH="80%"
1437ALIGN="LEFT"
1438VALIGN="TOP"
1439> An entity table</TD
1440></TR
1441></TABLE
1442><P
1443></P
1444></DIV
1445></DIV
1446><HR><DIV
1447CLASS="REFSECT2"
1448><A
Daniel Veillard011b63c1999-06-02 17:44:04 +0000[diff] [blame^]1449NAME="AEN3827"
Daniel Veillard35925471999-02-25 08:46:07 +0000[diff] [blame]1450></A
1451><H3
1452><A
1453NAME="XMLDUMPENTITIESTABLE"
1454></A
1455>xmlDumpEntitiesTable()</H3
1456><TABLE
1457BORDER="0"
1458BGCOLOR="#E8E8F8"
1459WIDTH="100%"
1460CELLPADDING="6"
1461><TR
1462><TD
1463><PRE
1464CLASS="PROGRAMLISTING"
1465>void xmlDumpEntitiesTable (<A
Daniel Veillard5099ae81999-04-21 20:12:07 +0000[diff] [blame]1466HREF="gnome-xml-tree.html#XMLBUFFERPTR"
1467>xmlBufferPtr</A
1468> buf,
1469 <A
Daniel Veillard35925471999-02-25 08:46:07 +0000[diff] [blame]1470HREF="gnome-xml-entities.html#XMLENTITIESTABLEPTR"
1471>xmlEntitiesTablePtr</A
1472> table);</PRE
1473></TD
1474></TR
1475></TABLE
1476><P
1477>This will dump the content of the entity table as an XML DTD definition</P
1478><P
Daniel Veillard35925471999-02-25 08:46:07 +0000[diff] [blame]1479></P
1480><DIV
1481CLASS="INFORMALTABLE"
1482><P
1483></P
1484><TABLE
1485BORDER="0"
1486WIDTH="100%"
1487BGCOLOR="#FFE0E0"
1488CELLSPACING="0"
1489CELLPADDING="4"
1490CLASS="CALSTABLE"
1491><TR
1492><TD
1493WIDTH="20%"
1494ALIGN="RIGHT"
1495VALIGN="TOP"
1496><TT
1497CLASS="PARAMETER"
1498><I
Daniel Veillard5099ae81999-04-21 20:12:07 +0000[diff] [blame]1499>buf</I
1500></TT
1501>&nbsp;:</TD
1502><TD
1503WIDTH="80%"
1504ALIGN="LEFT"
1505VALIGN="TOP"
1506> An XML buffer.</TD
1507></TR
1508><TR
1509><TD
1510WIDTH="20%"
1511ALIGN="RIGHT"
1512VALIGN="TOP"
1513><TT
1514CLASS="PARAMETER"
1515><I
Daniel Veillard35925471999-02-25 08:46:07 +0000[diff] [blame]1516>table</I
1517></TT
1518>&nbsp;:</TD
1519><TD
1520WIDTH="80%"
1521ALIGN="LEFT"
1522VALIGN="TOP"
1523> An entity table</TD
1524></TR
1525></TABLE
1526><P
1527></P
1528></DIV
1529></DIV
Daniel Veillard35925471999-02-25 08:46:07 +0000[diff] [blame]1530></DIV
1531><DIV
1532CLASS="NAVFOOTER"
1533><HR
1534ALIGN="LEFT"
1535WIDTH="100%"><TABLE
1536WIDTH="100%"
1537BORDER="0"
1538CELLPADDING="0"
1539CELLSPACING="0"
1540><TR
1541><TD
1542WIDTH="33%"
1543ALIGN="left"
1544VALIGN="top"
1545><A
1546HREF="gnome-xml-tree.html"
1547>Prev</A
1548></TD
1549><TD
1550WIDTH="34%"
1551ALIGN="center"
1552VALIGN="top"
1553><A
1554HREF="book1.html"
1555>Home</A
1556></TD
1557><TD
1558WIDTH="33%"
1559ALIGN="right"
1560VALIGN="top"
1561><A
1562HREF="gnome-xml-valid.html"
1563>Next</A
1564></TD
1565></TR
1566><TR
1567><TD
1568WIDTH="33%"
1569ALIGN="left"
1570VALIGN="top"
1571>tree</TD
1572><TD
1573WIDTH="34%"
1574ALIGN="center"
1575VALIGN="top"
1576><A
1577HREF="libxml.html"
1578>Up</A
1579></TD
1580><TD
1581WIDTH="33%"
1582ALIGN="right"
1583VALIGN="top"
1584>valid</TD
1585></TR
1586></TABLE
1587></DIV
1588></BODY
1589></HTML
1590>