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