Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / libxml2 / 35925478d126676b7f9a0c51d17e2a1c79253df2 / . / doc / html / gnome-xml-entities.html
blob: 1e9e7ed66da1a1434d883e689974d51bfe001a6f [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
68NAME="AEN2955"
69></A
70><H2
71>Name</H2
72>entities &#8212; one line description goes here.</DIV
73><DIV
74CLASS="REFSYNOPSISDIV"
75><A
76NAME="AEN2958"
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
255HREF="gnome-xml-entities.html#XMLENTITIESTABLEPTR"
256>xmlEntitiesTablePtr</A
257> table);
258<A
259HREF="gnome-xml-parser.html#XMLPARSERINPUTPTR"
260>xmlParserInputPtr</A
261> <A
262HREF="gnome-xml-entities.html#XMLNEWENTITYINPUTSTREAM"
263>xmlNewEntityInputStream</A
264> (<A
265HREF="gnome-xml-parser.html#XMLPARSERCTXTPTR"
266>xmlParserCtxtPtr</A
267> ctxt,
268 <A
269HREF="gnome-xml-entities.html#XMLENTITYPTR"
270>xmlEntityPtr</A
271> entity);</PRE
272></TD
273></TR
274></TABLE
275></DIV
276><DIV
277CLASS="REFSECT1"
278><A
279NAME="AEN3010"
280></A
281><H2
282>Description</H2
283><P
284></P
285></DIV
286><DIV
287CLASS="REFSECT1"
288><A
289NAME="AEN3013"
290></A
291><H2
292>Details</H2
293><HR><DIV
294CLASS="REFSECT2"
295><A
296NAME="AEN3015"
297></A
298><H3
299><A
300NAME="XML-INTERNAL-GENERAL-ENTITY"
301></A
302>XML_INTERNAL_GENERAL_ENTITY</H3
303><TABLE
304BORDER="0"
305BGCOLOR="#E8E8F8"
306WIDTH="100%"
307CELLPADDING="6"
308><TR
309><TD
310><PRE
311CLASS="PROGRAMLISTING"
312>#define XML_INTERNAL_GENERAL_ENTITY 1</PRE
313></TD
314></TR
315></TABLE
316><P
317></P
318></DIV
319><HR><DIV
320CLASS="REFSECT2"
321><A
322NAME="AEN3020"
323></A
324><H3
325><A
326NAME="XML-EXTERNAL-GENERAL-PARSED-ENTITY"
327></A
328>XML_EXTERNAL_GENERAL_PARSED_ENTITY</H3
329><TABLE
330BORDER="0"
331BGCOLOR="#E8E8F8"
332WIDTH="100%"
333CELLPADDING="6"
334><TR
335><TD
336><PRE
337CLASS="PROGRAMLISTING"
338>#define XML_EXTERNAL_GENERAL_PARSED_ENTITY 2</PRE
339></TD
340></TR
341></TABLE
342><P
343></P
344></DIV
345><HR><DIV
346CLASS="REFSECT2"
347><A
348NAME="AEN3025"
349></A
350><H3
351><A
352NAME="XML-EXTERNAL-GENERAL-UNPARSED-ENTITY"
353></A
354>XML_EXTERNAL_GENERAL_UNPARSED_ENTITY</H3
355><TABLE
356BORDER="0"
357BGCOLOR="#E8E8F8"
358WIDTH="100%"
359CELLPADDING="6"
360><TR
361><TD
362><PRE
363CLASS="PROGRAMLISTING"
364>#define XML_EXTERNAL_GENERAL_UNPARSED_ENTITY 3</PRE
365></TD
366></TR
367></TABLE
368><P
369></P
370></DIV
371><HR><DIV
372CLASS="REFSECT2"
373><A
374NAME="AEN3030"
375></A
376><H3
377><A
378NAME="XML-INTERNAL-PARAMETER-ENTITY"
379></A
380>XML_INTERNAL_PARAMETER_ENTITY</H3
381><TABLE
382BORDER="0"
383BGCOLOR="#E8E8F8"
384WIDTH="100%"
385CELLPADDING="6"
386><TR
387><TD
388><PRE
389CLASS="PROGRAMLISTING"
390>#define XML_INTERNAL_PARAMETER_ENTITY 4</PRE
391></TD
392></TR
393></TABLE
394><P
395></P
396></DIV
397><HR><DIV
398CLASS="REFSECT2"
399><A
400NAME="AEN3035"
401></A
402><H3
403><A
404NAME="XML-EXTERNAL-PARAMETER-ENTITY"
405></A
406>XML_EXTERNAL_PARAMETER_ENTITY</H3
407><TABLE
408BORDER="0"
409BGCOLOR="#E8E8F8"
410WIDTH="100%"
411CELLPADDING="6"
412><TR
413><TD
414><PRE
415CLASS="PROGRAMLISTING"
416>#define XML_EXTERNAL_PARAMETER_ENTITY 5</PRE
417></TD
418></TR
419></TABLE
420><P
421></P
422></DIV
423><HR><DIV
424CLASS="REFSECT2"
425><A
426NAME="AEN3040"
427></A
428><H3
429><A
430NAME="XML-INTERNAL-PREDEFINED-ENTITY"
431></A
432>XML_INTERNAL_PREDEFINED_ENTITY</H3
433><TABLE
434BORDER="0"
435BGCOLOR="#E8E8F8"
436WIDTH="100%"
437CELLPADDING="6"
438><TR
439><TD
440><PRE
441CLASS="PROGRAMLISTING"
442>#define XML_INTERNAL_PREDEFINED_ENTITY 6</PRE
443></TD
444></TR
445></TABLE
446><P
447></P
448></DIV
449><HR><DIV
450CLASS="REFSECT2"
451><A
452NAME="AEN3045"
453></A
454><H3
455><A
456NAME="XMLENTITYPTR"
457></A
458>xmlEntityPtr</H3
459><TABLE
460BORDER="0"
461BGCOLOR="#E8E8F8"
462WIDTH="100%"
463CELLPADDING="6"
464><TR
465><TD
466><PRE
467CLASS="PROGRAMLISTING"
468>typedef xmlEntity *xmlEntityPtr;</PRE
469></TD
470></TR
471></TABLE
472><P
473></P
474></DIV
475><HR><DIV
476CLASS="REFSECT2"
477><A
478NAME="AEN3050"
479></A
480><H3
481><A
482NAME="XML-MIN-ENTITIES-TABLE"
483></A
484>XML_MIN_ENTITIES_TABLE</H3
485><TABLE
486BORDER="0"
487BGCOLOR="#E8E8F8"
488WIDTH="100%"
489CELLPADDING="6"
490><TR
491><TD
492><PRE
493CLASS="PROGRAMLISTING"
494>#define XML_MIN_ENTITIES_TABLE 32</PRE
495></TD
496></TR
497></TABLE
498><P
499></P
500></DIV
501><HR><DIV
502CLASS="REFSECT2"
503><A
504NAME="AEN3055"
505></A
506><H3
507><A
508NAME="XMLENTITIESTABLEPTR"
509></A
510>xmlEntitiesTablePtr</H3
511><TABLE
512BORDER="0"
513BGCOLOR="#E8E8F8"
514WIDTH="100%"
515CELLPADDING="6"
516><TR
517><TD
518><PRE
519CLASS="PROGRAMLISTING"
520>typedef xmlEntitiesTable *xmlEntitiesTablePtr;</PRE
521></TD
522></TR
523></TABLE
524><P
525></P
526></DIV
527><HR><DIV
528CLASS="REFSECT2"
529><A
530NAME="AEN3060"
531></A
532><H3
533><A
534NAME="XMLADDDOCENTITY"
535></A
536>xmlAddDocEntity()</H3
537><TABLE
538BORDER="0"
539BGCOLOR="#E8E8F8"
540WIDTH="100%"
541CELLPADDING="6"
542><TR
543><TD
544><PRE
545CLASS="PROGRAMLISTING"
546>void xmlAddDocEntity (<A
547HREF="gnome-xml-tree.html#XMLDOCPTR"
548>xmlDocPtr</A
549> doc,
550 const <A
551HREF="gnome-xml-tree.html#CHAR"
552>CHAR</A
553> *name,
554 int type,
555 const <A
556HREF="gnome-xml-tree.html#CHAR"
557>CHAR</A
558> *ExternalID,
559 const <A
560HREF="gnome-xml-tree.html#CHAR"
561>CHAR</A
562> *SystemID,
563 <A
564HREF="gnome-xml-tree.html#CHAR"
565>CHAR</A
566> *content);</PRE
567></TD
568></TR
569></TABLE
570><P
571>Register a new entity for this document.</P
572><P
573></P
574><DIV
575CLASS="INFORMALTABLE"
576><P
577></P
578><TABLE
579BORDER="0"
580WIDTH="100%"
581BGCOLOR="#FFE0E0"
582CELLSPACING="0"
583CELLPADDING="4"
584CLASS="CALSTABLE"
585><TR
586><TD
587WIDTH="20%"
588ALIGN="RIGHT"
589VALIGN="TOP"
590><TT
591CLASS="PARAMETER"
592><I
593>doc</I
594></TT
595>&nbsp;:</TD
596><TD
597WIDTH="80%"
598ALIGN="LEFT"
599VALIGN="TOP"
600> the document</TD
601></TR
602><TR
603><TD
604WIDTH="20%"
605ALIGN="RIGHT"
606VALIGN="TOP"
607><TT
608CLASS="PARAMETER"
609><I
610>name</I
611></TT
612>&nbsp;:</TD
613><TD
614WIDTH="80%"
615ALIGN="LEFT"
616VALIGN="TOP"
617> the entity name</TD
618></TR
619><TR
620><TD
621WIDTH="20%"
622ALIGN="RIGHT"
623VALIGN="TOP"
624><TT
625CLASS="PARAMETER"
626><I
627>type</I
628></TT
629>&nbsp;:</TD
630><TD
631WIDTH="80%"
632ALIGN="LEFT"
633VALIGN="TOP"
634> the entity type XML_xxx_yyy_ENTITY</TD
635></TR
636><TR
637><TD
638WIDTH="20%"
639ALIGN="RIGHT"
640VALIGN="TOP"
641><TT
642CLASS="PARAMETER"
643><I
644>ExternalID</I
645></TT
646>&nbsp;:</TD
647><TD
648WIDTH="80%"
649ALIGN="LEFT"
650VALIGN="TOP"
651> the entity external ID if available</TD
652></TR
653><TR
654><TD
655WIDTH="20%"
656ALIGN="RIGHT"
657VALIGN="TOP"
658><TT
659CLASS="PARAMETER"
660><I
661>SystemID</I
662></TT
663>&nbsp;:</TD
664><TD
665WIDTH="80%"
666ALIGN="LEFT"
667VALIGN="TOP"
668> the entity system ID if available</TD
669></TR
670><TR
671><TD
672WIDTH="20%"
673ALIGN="RIGHT"
674VALIGN="TOP"
675><TT
676CLASS="PARAMETER"
677><I
678>content</I
679></TT
680>&nbsp;:</TD
681><TD
682WIDTH="80%"
683ALIGN="LEFT"
684VALIGN="TOP"
685> the entity content</TD
686></TR
687></TABLE
688><P
689></P
690></DIV
691></DIV
692><HR><DIV
693CLASS="REFSECT2"
694><A
695NAME="AEN3100"
696></A
697><H3
698><A
699NAME="XMLADDDTDENTITY"
700></A
701>xmlAddDtdEntity()</H3
702><TABLE
703BORDER="0"
704BGCOLOR="#E8E8F8"
705WIDTH="100%"
706CELLPADDING="6"
707><TR
708><TD
709><PRE
710CLASS="PROGRAMLISTING"
711>void xmlAddDtdEntity (<A
712HREF="gnome-xml-tree.html#XMLDOCPTR"
713>xmlDocPtr</A
714> doc,
715 const <A
716HREF="gnome-xml-tree.html#CHAR"
717>CHAR</A
718> *name,
719 int type,
720 const <A
721HREF="gnome-xml-tree.html#CHAR"
722>CHAR</A
723> *ExternalID,
724 const <A
725HREF="gnome-xml-tree.html#CHAR"
726>CHAR</A
727> *SystemID,
728 <A
729HREF="gnome-xml-tree.html#CHAR"
730>CHAR</A
731> *content);</PRE
732></TD
733></TR
734></TABLE
735><P
736>Register a new entity for this document DTD.</P
737><P
738></P
739><DIV
740CLASS="INFORMALTABLE"
741><P
742></P
743><TABLE
744BORDER="0"
745WIDTH="100%"
746BGCOLOR="#FFE0E0"
747CELLSPACING="0"
748CELLPADDING="4"
749CLASS="CALSTABLE"
750><TR
751><TD
752WIDTH="20%"
753ALIGN="RIGHT"
754VALIGN="TOP"
755><TT
756CLASS="PARAMETER"
757><I
758>doc</I
759></TT
760>&nbsp;:</TD
761><TD
762WIDTH="80%"
763ALIGN="LEFT"
764VALIGN="TOP"
765> the document</TD
766></TR
767><TR
768><TD
769WIDTH="20%"
770ALIGN="RIGHT"
771VALIGN="TOP"
772><TT
773CLASS="PARAMETER"
774><I
775>name</I
776></TT
777>&nbsp;:</TD
778><TD
779WIDTH="80%"
780ALIGN="LEFT"
781VALIGN="TOP"
782> the entity name</TD
783></TR
784><TR
785><TD
786WIDTH="20%"
787ALIGN="RIGHT"
788VALIGN="TOP"
789><TT
790CLASS="PARAMETER"
791><I
792>type</I
793></TT
794>&nbsp;:</TD
795><TD
796WIDTH="80%"
797ALIGN="LEFT"
798VALIGN="TOP"
799> the entity type XML_xxx_yyy_ENTITY</TD
800></TR
801><TR
802><TD
803WIDTH="20%"
804ALIGN="RIGHT"
805VALIGN="TOP"
806><TT
807CLASS="PARAMETER"
808><I
809>ExternalID</I
810></TT
811>&nbsp;:</TD
812><TD
813WIDTH="80%"
814ALIGN="LEFT"
815VALIGN="TOP"
816> the entity external ID if available</TD
817></TR
818><TR
819><TD
820WIDTH="20%"
821ALIGN="RIGHT"
822VALIGN="TOP"
823><TT
824CLASS="PARAMETER"
825><I
826>SystemID</I
827></TT
828>&nbsp;:</TD
829><TD
830WIDTH="80%"
831ALIGN="LEFT"
832VALIGN="TOP"
833> the entity system ID if available</TD
834></TR
835><TR
836><TD
837WIDTH="20%"
838ALIGN="RIGHT"
839VALIGN="TOP"
840><TT
841CLASS="PARAMETER"
842><I
843>content</I
844></TT
845>&nbsp;:</TD
846><TD
847WIDTH="80%"
848ALIGN="LEFT"
849VALIGN="TOP"
850> the entity content</TD
851></TR
852></TABLE
853><P
854></P
855></DIV
856></DIV
857><HR><DIV
858CLASS="REFSECT2"
859><A
860NAME="AEN3140"
861></A
862><H3
863><A
864NAME="XMLGETPREDEFINEDENTITY"
865></A
866>xmlGetPredefinedEntity()</H3
867><TABLE
868BORDER="0"
869BGCOLOR="#E8E8F8"
870WIDTH="100%"
871CELLPADDING="6"
872><TR
873><TD
874><PRE
875CLASS="PROGRAMLISTING"
876><A
877HREF="gnome-xml-entities.html#XMLENTITYPTR"
878>xmlEntityPtr</A
879> xmlGetPredefinedEntity (const <A
880HREF="gnome-xml-tree.html#CHAR"
881>CHAR</A
882> *name);</PRE
883></TD
884></TR
885></TABLE
886><P
887>Check whether this name is an predefined entity.</P
888><P
889></P
890><DIV
891CLASS="INFORMALTABLE"
892><P
893></P
894><TABLE
895BORDER="0"
896WIDTH="100%"
897BGCOLOR="#FFE0E0"
898CELLSPACING="0"
899CELLPADDING="4"
900CLASS="CALSTABLE"
901><TR
902><TD
903WIDTH="20%"
904ALIGN="RIGHT"
905VALIGN="TOP"
906><TT
907CLASS="PARAMETER"
908><I
909>name</I
910></TT
911>&nbsp;:</TD
912><TD
913WIDTH="80%"
914ALIGN="LEFT"
915VALIGN="TOP"
916> the entity name</TD
917></TR
918><TR
919><TD
920WIDTH="20%"
921ALIGN="RIGHT"
922VALIGN="TOP"
923><I
924CLASS="EMPHASIS"
925>Returns</I
926> :</TD
927><TD
928WIDTH="80%"
929ALIGN="LEFT"
930VALIGN="TOP"
931>NULL if not, othervise the entity</TD
932></TR
933></TABLE
934><P
935></P
936></DIV
937></DIV
938><HR><DIV
939CLASS="REFSECT2"
940><A
941NAME="AEN3161"
942></A
943><H3
944><A
945NAME="XMLGETDOCENTITY"
946></A
947>xmlGetDocEntity()</H3
948><TABLE
949BORDER="0"
950BGCOLOR="#E8E8F8"
951WIDTH="100%"
952CELLPADDING="6"
953><TR
954><TD
955><PRE
956CLASS="PROGRAMLISTING"
957><A
958HREF="gnome-xml-entities.html#XMLENTITYPTR"
959>xmlEntityPtr</A
960> xmlGetDocEntity (<A
961HREF="gnome-xml-tree.html#XMLDOCPTR"
962>xmlDocPtr</A
963> doc,
964 const <A
965HREF="gnome-xml-tree.html#CHAR"
966>CHAR</A
967> *name);</PRE
968></TD
969></TR
970></TABLE
971><P
972>Do an entity lookup in the document entity hash table and
973returns the corrsponding entity, otherwise a lookup is done
974in the predefined entities too.</P
975><P
976></P
977><DIV
978CLASS="INFORMALTABLE"
979><P
980></P
981><TABLE
982BORDER="0"
983WIDTH="100%"
984BGCOLOR="#FFE0E0"
985CELLSPACING="0"
986CELLPADDING="4"
987CLASS="CALSTABLE"
988><TR
989><TD
990WIDTH="20%"
991ALIGN="RIGHT"
992VALIGN="TOP"
993><TT
994CLASS="PARAMETER"
995><I
996>doc</I
997></TT
998>&nbsp;:</TD
999><TD
1000WIDTH="80%"
1001ALIGN="LEFT"
1002VALIGN="TOP"
1003> the document referencing the entity</TD
1004></TR
1005><TR
1006><TD
1007WIDTH="20%"
1008ALIGN="RIGHT"
1009VALIGN="TOP"
1010><TT
1011CLASS="PARAMETER"
1012><I
1013>name</I
1014></TT
1015>&nbsp;:</TD
1016><TD
1017WIDTH="80%"
1018ALIGN="LEFT"
1019VALIGN="TOP"
1020> the entity name</TD
1021></TR
1022><TR
1023><TD
1024WIDTH="20%"
1025ALIGN="RIGHT"
1026VALIGN="TOP"
1027><I
1028CLASS="EMPHASIS"
1029>Returns</I
1030> :</TD
1031><TD
1032WIDTH="80%"
1033ALIGN="LEFT"
1034VALIGN="TOP"
1035>A pointer to the entity structure or NULL if not found.</TD
1036></TR
1037></TABLE
1038><P
1039></P
1040></DIV
1041></DIV
1042><HR><DIV
1043CLASS="REFSECT2"
1044><A
1045NAME="AEN3187"
1046></A
1047><H3
1048><A
1049NAME="XMLGETDTDENTITY"
1050></A
1051>xmlGetDtdEntity()</H3
1052><TABLE
1053BORDER="0"
1054BGCOLOR="#E8E8F8"
1055WIDTH="100%"
1056CELLPADDING="6"
1057><TR
1058><TD
1059><PRE
1060CLASS="PROGRAMLISTING"
1061><A
1062HREF="gnome-xml-entities.html#XMLENTITYPTR"
1063>xmlEntityPtr</A
1064> xmlGetDtdEntity (<A
1065HREF="gnome-xml-tree.html#XMLDOCPTR"
1066>xmlDocPtr</A
1067> doc,
1068 const <A
1069HREF="gnome-xml-tree.html#CHAR"
1070>CHAR</A
1071> *name);</PRE
1072></TD
1073></TR
1074></TABLE
1075><P
1076>Do an entity lookup in the Dtd entity hash table and
1077returns the corresponding entity, if found.</P
1078><P
1079></P
1080><DIV
1081CLASS="INFORMALTABLE"
1082><P
1083></P
1084><TABLE
1085BORDER="0"
1086WIDTH="100%"
1087BGCOLOR="#FFE0E0"
1088CELLSPACING="0"
1089CELLPADDING="4"
1090CLASS="CALSTABLE"
1091><TR
1092><TD
1093WIDTH="20%"
1094ALIGN="RIGHT"
1095VALIGN="TOP"
1096><TT
1097CLASS="PARAMETER"
1098><I
1099>doc</I
1100></TT
1101>&nbsp;:</TD
1102><TD
1103WIDTH="80%"
1104ALIGN="LEFT"
1105VALIGN="TOP"
1106> the document referencing the entity</TD
1107></TR
1108><TR
1109><TD
1110WIDTH="20%"
1111ALIGN="RIGHT"
1112VALIGN="TOP"
1113><TT
1114CLASS="PARAMETER"
1115><I
1116>name</I
1117></TT
1118>&nbsp;:</TD
1119><TD
1120WIDTH="80%"
1121ALIGN="LEFT"
1122VALIGN="TOP"
1123> the entity name</TD
1124></TR
1125><TR
1126><TD
1127WIDTH="20%"
1128ALIGN="RIGHT"
1129VALIGN="TOP"
1130><I
1131CLASS="EMPHASIS"
1132>Returns</I
1133> :</TD
1134><TD
1135WIDTH="80%"
1136ALIGN="LEFT"
1137VALIGN="TOP"
1138>A pointer to the entity structure or NULL if not found.</TD
1139></TR
1140></TABLE
1141><P
1142></P
1143></DIV
1144></DIV
1145><HR><DIV
1146CLASS="REFSECT2"
1147><A
1148NAME="AEN3213"
1149></A
1150><H3
1151><A
1152NAME="XMLENCODEENTITIES"
1153></A
1154>xmlEncodeEntities()</H3
1155><TABLE
1156BORDER="0"
1157BGCOLOR="#E8E8F8"
1158WIDTH="100%"
1159CELLPADDING="6"
1160><TR
1161><TD
1162><PRE
1163CLASS="PROGRAMLISTING"
1164><A
1165HREF="gnome-xml-tree.html#CHAR"
1166>CHAR</A
1167>* xmlEncodeEntities (<A
1168HREF="gnome-xml-tree.html#XMLDOCPTR"
1169>xmlDocPtr</A
1170> doc,
1171 const <A
1172HREF="gnome-xml-tree.html#CHAR"
1173>CHAR</A
1174> *input);</PRE
1175></TD
1176></TR
1177></TABLE
1178><P
1179>Do a global encoding of a string, replacing the predefined entities
1180and non ASCII values with their entities and CharRef counterparts.</P
1181><P
1182>TODO !!!! Once moved to UTF-8 internal encoding, the encoding of non-ascii
1183get erroneous.</P
1184><P
1185>TODO This routine is not reentrant and this will be changed, the interface
1186should not be modified though.</P
1187><P
1188></P
1189><DIV
1190CLASS="INFORMALTABLE"
1191><P
1192></P
1193><TABLE
1194BORDER="0"
1195WIDTH="100%"
1196BGCOLOR="#FFE0E0"
1197CELLSPACING="0"
1198CELLPADDING="4"
1199CLASS="CALSTABLE"
1200><TR
1201><TD
1202WIDTH="20%"
1203ALIGN="RIGHT"
1204VALIGN="TOP"
1205><TT
1206CLASS="PARAMETER"
1207><I
1208>doc</I
1209></TT
1210>&nbsp;:</TD
1211><TD
1212WIDTH="80%"
1213ALIGN="LEFT"
1214VALIGN="TOP"
1215> the document containing the string</TD
1216></TR
1217><TR
1218><TD
1219WIDTH="20%"
1220ALIGN="RIGHT"
1221VALIGN="TOP"
1222><TT
1223CLASS="PARAMETER"
1224><I
1225>input</I
1226></TT
1227>&nbsp;:</TD
1228><TD
1229WIDTH="80%"
1230ALIGN="LEFT"
1231VALIGN="TOP"
1232> A string to convert to XML.</TD
1233></TR
1234><TR
1235><TD
1236WIDTH="20%"
1237ALIGN="RIGHT"
1238VALIGN="TOP"
1239><I
1240CLASS="EMPHASIS"
1241>Returns</I
1242> :</TD
1243><TD
1244WIDTH="80%"
1245ALIGN="LEFT"
1246VALIGN="TOP"
1247>A newly allocated string with the substitution done.</TD
1248></TR
1249></TABLE
1250><P
1251></P
1252></DIV
1253></DIV
1254><HR><DIV
1255CLASS="REFSECT2"
1256><A
1257NAME="AEN3241"
1258></A
1259><H3
1260><A
1261NAME="XMLCREATEENTITIESTABLE"
1262></A
1263>xmlCreateEntitiesTable()</H3
1264><TABLE
1265BORDER="0"
1266BGCOLOR="#E8E8F8"
1267WIDTH="100%"
1268CELLPADDING="6"
1269><TR
1270><TD
1271><PRE
1272CLASS="PROGRAMLISTING"
1273><A
1274HREF="gnome-xml-entities.html#XMLENTITIESTABLEPTR"
1275>xmlEntitiesTablePtr</A
1276> xmlCreateEntitiesTable (void);</PRE
1277></TD
1278></TR
1279></TABLE
1280><P
1281>create and initialize an empty entities hash table.</P
1282><P
1283></P
1284><DIV
1285CLASS="INFORMALTABLE"
1286><P
1287></P
1288><TABLE
1289BORDER="0"
1290WIDTH="100%"
1291BGCOLOR="#FFE0E0"
1292CELLSPACING="0"
1293CELLPADDING="4"
1294CLASS="CALSTABLE"
1295><TR
1296><TD
1297WIDTH="20%"
1298ALIGN="RIGHT"
1299VALIGN="TOP"
1300><I
1301CLASS="EMPHASIS"
1302>Returns</I
1303> :</TD
1304><TD
1305WIDTH="80%"
1306ALIGN="LEFT"
1307VALIGN="TOP"
1308>the xmlEntitiesTablePtr just created or NULL in case of error.</TD
1309></TR
1310></TABLE
1311><P
1312></P
1313></DIV
1314></DIV
1315><HR><DIV
1316CLASS="REFSECT2"
1317><A
1318NAME="AEN3257"
1319></A
1320><H3
1321><A
1322NAME="XMLCOPYENTITIESTABLE"
1323></A
1324>xmlCopyEntitiesTable()</H3
1325><TABLE
1326BORDER="0"
1327BGCOLOR="#E8E8F8"
1328WIDTH="100%"
1329CELLPADDING="6"
1330><TR
1331><TD
1332><PRE
1333CLASS="PROGRAMLISTING"
1334><A
1335HREF="gnome-xml-entities.html#XMLENTITIESTABLEPTR"
1336>xmlEntitiesTablePtr</A
1337> xmlCopyEntitiesTable (<A
1338HREF="gnome-xml-entities.html#XMLENTITIESTABLEPTR"
1339>xmlEntitiesTablePtr</A
1340> table);</PRE
1341></TD
1342></TR
1343></TABLE
1344><P
1345>Build a copy of an entity table.</P
1346><P
1347></P
1348><DIV
1349CLASS="INFORMALTABLE"
1350><P
1351></P
1352><TABLE
1353BORDER="0"
1354WIDTH="100%"
1355BGCOLOR="#FFE0E0"
1356CELLSPACING="0"
1357CELLPADDING="4"
1358CLASS="CALSTABLE"
1359><TR
1360><TD
1361WIDTH="20%"
1362ALIGN="RIGHT"
1363VALIGN="TOP"
1364><TT
1365CLASS="PARAMETER"
1366><I
1367>table</I
1368></TT
1369>&nbsp;:</TD
1370><TD
1371WIDTH="80%"
1372ALIGN="LEFT"
1373VALIGN="TOP"
1374> An entity table</TD
1375></TR
1376><TR
1377><TD
1378WIDTH="20%"
1379ALIGN="RIGHT"
1380VALIGN="TOP"
1381><I
1382CLASS="EMPHASIS"
1383>Returns</I
1384> :</TD
1385><TD
1386WIDTH="80%"
1387ALIGN="LEFT"
1388VALIGN="TOP"
1389>the new xmlEntitiesTablePtr or NULL in case of error.</TD
1390></TR
1391></TABLE
1392><P
1393></P
1394></DIV
1395></DIV
1396><HR><DIV
1397CLASS="REFSECT2"
1398><A
1399NAME="AEN3278"
1400></A
1401><H3
1402><A
1403NAME="XMLFREEENTITIESTABLE"
1404></A
1405>xmlFreeEntitiesTable()</H3
1406><TABLE
1407BORDER="0"
1408BGCOLOR="#E8E8F8"
1409WIDTH="100%"
1410CELLPADDING="6"
1411><TR
1412><TD
1413><PRE
1414CLASS="PROGRAMLISTING"
1415>void xmlFreeEntitiesTable (<A
1416HREF="gnome-xml-entities.html#XMLENTITIESTABLEPTR"
1417>xmlEntitiesTablePtr</A
1418> table);</PRE
1419></TD
1420></TR
1421></TABLE
1422><P
1423>Deallocate the memory used by an entities hash table.</P
1424><P
1425></P
1426><DIV
1427CLASS="INFORMALTABLE"
1428><P
1429></P
1430><TABLE
1431BORDER="0"
1432WIDTH="100%"
1433BGCOLOR="#FFE0E0"
1434CELLSPACING="0"
1435CELLPADDING="4"
1436CLASS="CALSTABLE"
1437><TR
1438><TD
1439WIDTH="20%"
1440ALIGN="RIGHT"
1441VALIGN="TOP"
1442><TT
1443CLASS="PARAMETER"
1444><I
1445>table</I
1446></TT
1447>&nbsp;:</TD
1448><TD
1449WIDTH="80%"
1450ALIGN="LEFT"
1451VALIGN="TOP"
1452> An entity table</TD
1453></TR
1454></TABLE
1455><P
1456></P
1457></DIV
1458></DIV
1459><HR><DIV
1460CLASS="REFSECT2"
1461><A
1462NAME="AEN3294"
1463></A
1464><H3
1465><A
1466NAME="XMLDUMPENTITIESTABLE"
1467></A
1468>xmlDumpEntitiesTable()</H3
1469><TABLE
1470BORDER="0"
1471BGCOLOR="#E8E8F8"
1472WIDTH="100%"
1473CELLPADDING="6"
1474><TR
1475><TD
1476><PRE
1477CLASS="PROGRAMLISTING"
1478>void xmlDumpEntitiesTable (<A
1479HREF="gnome-xml-entities.html#XMLENTITIESTABLEPTR"
1480>xmlEntitiesTablePtr</A
1481> table);</PRE
1482></TD
1483></TR
1484></TABLE
1485><P
1486>This will dump the content of the entity table as an XML DTD definition</P
1487><P
1488>NOTE: TODO an extra parameter allowing a reentant implementation will
1489be added.</P
1490><P
1491></P
1492><DIV
1493CLASS="INFORMALTABLE"
1494><P
1495></P
1496><TABLE
1497BORDER="0"
1498WIDTH="100%"
1499BGCOLOR="#FFE0E0"
1500CELLSPACING="0"
1501CELLPADDING="4"
1502CLASS="CALSTABLE"
1503><TR
1504><TD
1505WIDTH="20%"
1506ALIGN="RIGHT"
1507VALIGN="TOP"
1508><TT
1509CLASS="PARAMETER"
1510><I
1511>table</I
1512></TT
1513>&nbsp;:</TD
1514><TD
1515WIDTH="80%"
1516ALIGN="LEFT"
1517VALIGN="TOP"
1518> An entity table</TD
1519></TR
1520></TABLE
1521><P
1522></P
1523></DIV
1524></DIV
1525><HR><DIV
1526CLASS="REFSECT2"
1527><A
1528NAME="AEN3311"
1529></A
1530><H3
1531><A
1532NAME="XMLNEWENTITYINPUTSTREAM"
1533></A
1534>xmlNewEntityInputStream()</H3
1535><TABLE
1536BORDER="0"
1537BGCOLOR="#E8E8F8"
1538WIDTH="100%"
1539CELLPADDING="6"
1540><TR
1541><TD
1542><PRE
1543CLASS="PROGRAMLISTING"
1544><A
1545HREF="gnome-xml-parser.html#XMLPARSERINPUTPTR"
1546>xmlParserInputPtr</A
1547> xmlNewEntityInputStream (<A
1548HREF="gnome-xml-parser.html#XMLPARSERCTXTPTR"
1549>xmlParserCtxtPtr</A
1550> ctxt,
1551 <A
1552HREF="gnome-xml-entities.html#XMLENTITYPTR"
1553>xmlEntityPtr</A
1554> entity);</PRE
1555></TD
1556></TR
1557></TABLE
1558><P
1559>Create a new input stream based on a memory buffer.</P
1560><P
1561></P
1562><DIV
1563CLASS="INFORMALTABLE"
1564><P
1565></P
1566><TABLE
1567BORDER="0"
1568WIDTH="100%"
1569BGCOLOR="#FFE0E0"
1570CELLSPACING="0"
1571CELLPADDING="4"
1572CLASS="CALSTABLE"
1573><TR
1574><TD
1575WIDTH="20%"
1576ALIGN="RIGHT"
1577VALIGN="TOP"
1578><TT
1579CLASS="PARAMETER"
1580><I
1581>ctxt</I
1582></TT
1583>&nbsp;:</TD
1584><TD
1585WIDTH="80%"
1586ALIGN="LEFT"
1587VALIGN="TOP"
1588> an XML parser context</TD
1589></TR
1590><TR
1591><TD
1592WIDTH="20%"
1593ALIGN="RIGHT"
1594VALIGN="TOP"
1595><TT
1596CLASS="PARAMETER"
1597><I
1598>entity</I
1599></TT
1600>&nbsp;:</TD
1601><TD
1602WIDTH="80%"
1603ALIGN="LEFT"
1604VALIGN="TOP"
1605> an Entity pointer</TD
1606></TR
1607><TR
1608><TD
1609WIDTH="20%"
1610ALIGN="RIGHT"
1611VALIGN="TOP"
1612><I
1613CLASS="EMPHASIS"
1614>Returns</I
1615> :</TD
1616><TD
1617WIDTH="80%"
1618ALIGN="LEFT"
1619VALIGN="TOP"
1620>the new input stream</TD
1621></TR
1622></TABLE
1623><P
1624></P
1625></DIV
1626></DIV
1627></DIV
1628><DIV
1629CLASS="NAVFOOTER"
1630><HR
1631ALIGN="LEFT"
1632WIDTH="100%"><TABLE
1633WIDTH="100%"
1634BORDER="0"
1635CELLPADDING="0"
1636CELLSPACING="0"
1637><TR
1638><TD
1639WIDTH="33%"
1640ALIGN="left"
1641VALIGN="top"
1642><A
1643HREF="gnome-xml-tree.html"
1644>Prev</A
1645></TD
1646><TD
1647WIDTH="34%"
1648ALIGN="center"
1649VALIGN="top"
1650><A
1651HREF="book1.html"
1652>Home</A
1653></TD
1654><TD
1655WIDTH="33%"
1656ALIGN="right"
1657VALIGN="top"
1658><A
1659HREF="gnome-xml-valid.html"
1660>Next</A
1661></TD
1662></TR
1663><TR
1664><TD
1665WIDTH="33%"
1666ALIGN="left"
1667VALIGN="top"
1668>tree</TD
1669><TD
1670WIDTH="34%"
1671ALIGN="center"
1672VALIGN="top"
1673><A
1674HREF="libxml.html"
1675>Up</A
1676></TD
1677><TD
1678WIDTH="33%"
1679ALIGN="right"
1680VALIGN="top"
1681>valid</TD
1682></TR
1683></TABLE
1684></DIV
1685></BODY
1686></HTML
1687>