xref: /aosp_15_r20/external/libxml2/doc/devhelp/libxml2-entities.html (revision 7c5688314b92172186c154356a6374bf7684c3ca)
1*7c568831SAndroid Build Coastguard Worker<html>
2*7c568831SAndroid Build Coastguard Worker<head>
3*7c568831SAndroid Build Coastguard Worker<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
4*7c568831SAndroid Build Coastguard Worker<title>entities: interface for the XML entities handling</title>
5*7c568831SAndroid Build Coastguard Worker<meta name="generator" content="Libxml2 devhelp stylesheet">
6*7c568831SAndroid Build Coastguard Worker<link rel="start" href="index.html" title="libxml2 Reference Manual">
7*7c568831SAndroid Build Coastguard Worker<link rel="up" href="general.html" title="API">
8*7c568831SAndroid Build Coastguard Worker<link rel="stylesheet" href="style.css" type="text/css">
9*7c568831SAndroid Build Coastguard Worker<link rel="chapter" href="general.html" title="API">
10*7c568831SAndroid Build Coastguard Worker</head>
11*7c568831SAndroid Build Coastguard Worker<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
12*7c568831SAndroid Build Coastguard Worker<table class="navigation" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle">
13*7c568831SAndroid Build Coastguard Worker<td><a accesskey="p" href="libxml2-encoding.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
14*7c568831SAndroid Build Coastguard Worker<td><a accesskey="u" href="general.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
15*7c568831SAndroid Build Coastguard Worker<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
16*7c568831SAndroid Build Coastguard Worker<td><a accesskey="n" href="libxml2-globals.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
17*7c568831SAndroid Build Coastguard Worker<th width="100%" align="center">libxml2 Reference Manual</th>
18*7c568831SAndroid Build Coastguard Worker</tr></table>
19*7c568831SAndroid Build Coastguard Worker<h2><span class="refentrytitle">entities</span></h2>
20*7c568831SAndroid Build Coastguard Worker<p>entities - interface for the XML entities handling</p>
21*7c568831SAndroid Build Coastguard Worker<p>this module provides some of the entity API needed for the parser and applications. </p>
22*7c568831SAndroid Build Coastguard Worker<p>Author(s): Daniel Veillard </p>
23*7c568831SAndroid Build Coastguard Worker<div class="refsynopsisdiv">
24*7c568831SAndroid Build Coastguard Worker<h2>Synopsis</h2>
25*7c568831SAndroid Build Coastguard Worker<pre class="synopsis">typedef struct _xmlHashTable <a href="#xmlEntitiesTable">xmlEntitiesTable</a>;
26*7c568831SAndroid Build Coastguard Workertypedef <a href="libxml2-entities.html#xmlEntitiesTable">xmlEntitiesTable</a> * <a href="#xmlEntitiesTablePtr">xmlEntitiesTablePtr</a>;
27*7c568831SAndroid Build Coastguard Workertypedef enum <a href="#xmlEntityType">xmlEntityType</a>;
28*7c568831SAndroid Build Coastguard Worker<a href="libxml2-tree.html#xmlEntityPtr">xmlEntityPtr</a>	<a href="#xmlAddDocEntity">xmlAddDocEntity</a>		(<a href="libxml2-tree.html#xmlDocPtr">xmlDocPtr</a> doc, <br>					 const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name, <br>					 int type, <br>					 const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * ExternalID, <br>					 const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * SystemID, <br>					 const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * content);
29*7c568831SAndroid Build Coastguard Worker<a href="libxml2-tree.html#xmlEntityPtr">xmlEntityPtr</a>	<a href="#xmlAddDtdEntity">xmlAddDtdEntity</a>		(<a href="libxml2-tree.html#xmlDocPtr">xmlDocPtr</a> doc, <br>					 const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name, <br>					 int type, <br>					 const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * ExternalID, <br>					 const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * SystemID, <br>					 const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * content);
30*7c568831SAndroid Build Coastguard Workerint	<a href="#xmlAddEntity">xmlAddEntity</a>			(<a href="libxml2-tree.html#xmlDocPtr">xmlDocPtr</a> doc, <br>					 int extSubset, <br>					 const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name, <br>					 int type, <br>					 const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * ExternalID, <br>					 const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * SystemID, <br>					 const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * content, <br>					 <a href="libxml2-tree.html#xmlEntityPtr">xmlEntityPtr</a> * out);
31*7c568831SAndroid Build Coastguard Workervoid	<a href="#xmlCleanupPredefinedEntities">xmlCleanupPredefinedEntities</a>	(void);
32*7c568831SAndroid Build Coastguard Worker<a href="libxml2-entities.html#xmlEntitiesTablePtr">xmlEntitiesTablePtr</a>	<a href="#xmlCopyEntitiesTable">xmlCopyEntitiesTable</a>	(<a href="libxml2-entities.html#xmlEntitiesTablePtr">xmlEntitiesTablePtr</a> table);
33*7c568831SAndroid Build Coastguard Worker<a href="libxml2-entities.html#xmlEntitiesTablePtr">xmlEntitiesTablePtr</a>	<a href="#xmlCreateEntitiesTable">xmlCreateEntitiesTable</a>	(void);
34*7c568831SAndroid Build Coastguard Workervoid	<a href="#xmlDumpEntitiesTable">xmlDumpEntitiesTable</a>		(<a href="libxml2-tree.html#xmlBufferPtr">xmlBufferPtr</a> buf, <br>					 <a href="libxml2-entities.html#xmlEntitiesTablePtr">xmlEntitiesTablePtr</a> table);
35*7c568831SAndroid Build Coastguard Workervoid	<a href="#xmlDumpEntityDecl">xmlDumpEntityDecl</a>		(<a href="libxml2-tree.html#xmlBufferPtr">xmlBufferPtr</a> buf, <br>					 <a href="libxml2-tree.html#xmlEntityPtr">xmlEntityPtr</a> ent);
36*7c568831SAndroid Build Coastguard Workerconst <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> *	<a href="#xmlEncodeEntities">xmlEncodeEntities</a>	(<a href="libxml2-tree.html#xmlDocPtr">xmlDocPtr</a> doc, <br>					 const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * input);
37*7c568831SAndroid Build Coastguard Worker<a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> *	<a href="#xmlEncodeEntitiesReentrant">xmlEncodeEntitiesReentrant</a>	(<a href="libxml2-tree.html#xmlDocPtr">xmlDocPtr</a> doc, <br>						 const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * input);
38*7c568831SAndroid Build Coastguard Worker<a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> *	<a href="#xmlEncodeSpecialChars">xmlEncodeSpecialChars</a>	(const <a href="libxml2-tree.html#xmlDoc">xmlDoc</a> * doc, <br>					 const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * input);
39*7c568831SAndroid Build Coastguard Workervoid	<a href="#xmlFreeEntitiesTable">xmlFreeEntitiesTable</a>		(<a href="libxml2-entities.html#xmlEntitiesTablePtr">xmlEntitiesTablePtr</a> table);
40*7c568831SAndroid Build Coastguard Workervoid	<a href="#xmlFreeEntity">xmlFreeEntity</a>			(<a href="libxml2-tree.html#xmlEntityPtr">xmlEntityPtr</a> entity);
41*7c568831SAndroid Build Coastguard Worker<a href="libxml2-tree.html#xmlEntityPtr">xmlEntityPtr</a>	<a href="#xmlGetDocEntity">xmlGetDocEntity</a>		(const <a href="libxml2-tree.html#xmlDoc">xmlDoc</a> * doc, <br>					 const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name);
42*7c568831SAndroid Build Coastguard Worker<a href="libxml2-tree.html#xmlEntityPtr">xmlEntityPtr</a>	<a href="#xmlGetDtdEntity">xmlGetDtdEntity</a>		(<a href="libxml2-tree.html#xmlDocPtr">xmlDocPtr</a> doc, <br>					 const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name);
43*7c568831SAndroid Build Coastguard Worker<a href="libxml2-tree.html#xmlEntityPtr">xmlEntityPtr</a>	<a href="#xmlGetParameterEntity">xmlGetParameterEntity</a>	(<a href="libxml2-tree.html#xmlDocPtr">xmlDocPtr</a> doc, <br>					 const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name);
44*7c568831SAndroid Build Coastguard Worker<a href="libxml2-tree.html#xmlEntityPtr">xmlEntityPtr</a>	<a href="#xmlGetPredefinedEntity">xmlGetPredefinedEntity</a>	(const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name);
45*7c568831SAndroid Build Coastguard Workervoid	<a href="#xmlInitializePredefinedEntities">xmlInitializePredefinedEntities</a>	(void);
46*7c568831SAndroid Build Coastguard Worker<a href="libxml2-tree.html#xmlEntityPtr">xmlEntityPtr</a>	<a href="#xmlNewEntity">xmlNewEntity</a>		(<a href="libxml2-tree.html#xmlDocPtr">xmlDocPtr</a> doc, <br>					 const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name, <br>					 int type, <br>					 const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * ExternalID, <br>					 const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * SystemID, <br>					 const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * content);
47*7c568831SAndroid Build Coastguard Worker</pre>
48*7c568831SAndroid Build Coastguard Worker</div>
49*7c568831SAndroid Build Coastguard Worker<div class="refsect1" lang="en"><h2>Description</h2></div>
50*7c568831SAndroid Build Coastguard Worker<div class="refsect1" lang="en">
51*7c568831SAndroid Build Coastguard Worker<h2>Details</h2>
52*7c568831SAndroid Build Coastguard Worker<div class="refsect2" lang="en">
53*7c568831SAndroid Build Coastguard Worker<div class="refsect2" lang="en">
54*7c568831SAndroid Build Coastguard Worker<h3>
55*7c568831SAndroid Build Coastguard Worker<a name="xmlEntitiesTable">Structure </a>xmlEntitiesTable</h3>
56*7c568831SAndroid Build Coastguard Worker<pre class="programlisting">struct _xmlHashTable {
57*7c568831SAndroid Build Coastguard WorkerThe content of this structure is not made public by the API.
58*7c568831SAndroid Build Coastguard Worker} xmlEntitiesTable;
59*7c568831SAndroid Build Coastguard Worker</pre>
60*7c568831SAndroid Build Coastguard Worker<p></p>
61*7c568831SAndroid Build Coastguard Worker</div>
62*7c568831SAndroid Build Coastguard Worker<hr>
63*7c568831SAndroid Build Coastguard Worker<div class="refsect2" lang="en">
64*7c568831SAndroid Build Coastguard Worker<h3>
65*7c568831SAndroid Build Coastguard Worker<a name="xmlEntitiesTablePtr">Typedef </a>xmlEntitiesTablePtr</h3>
66*7c568831SAndroid Build Coastguard Worker<pre class="programlisting"><a href="libxml2-entities.html#xmlEntitiesTable">xmlEntitiesTable</a> * xmlEntitiesTablePtr;
67*7c568831SAndroid Build Coastguard Worker</pre>
68*7c568831SAndroid Build Coastguard Worker<p></p>
69*7c568831SAndroid Build Coastguard Worker</div>
70*7c568831SAndroid Build Coastguard Worker<hr>
71*7c568831SAndroid Build Coastguard Worker<div class="refsect2" lang="en">
72*7c568831SAndroid Build Coastguard Worker<h3>
73*7c568831SAndroid Build Coastguard Worker<a name="xmlEntityType">Enum </a>xmlEntityType</h3>
74*7c568831SAndroid Build Coastguard Worker<pre class="programlisting">enum <a href="#xmlEntityType">xmlEntityType</a> {
75*7c568831SAndroid Build Coastguard Worker    <a name="XML_INTERNAL_GENERAL_ENTITY">XML_INTERNAL_GENERAL_ENTITY</a> = 1
76*7c568831SAndroid Build Coastguard Worker    <a name="XML_EXTERNAL_GENERAL_PARSED_ENTITY">XML_EXTERNAL_GENERAL_PARSED_ENTITY</a> = 2
77*7c568831SAndroid Build Coastguard Worker    <a name="XML_EXTERNAL_GENERAL_UNPARSED_ENTITY">XML_EXTERNAL_GENERAL_UNPARSED_ENTITY</a> = 3
78*7c568831SAndroid Build Coastguard Worker    <a name="XML_INTERNAL_PARAMETER_ENTITY">XML_INTERNAL_PARAMETER_ENTITY</a> = 4
79*7c568831SAndroid Build Coastguard Worker    <a name="XML_EXTERNAL_PARAMETER_ENTITY">XML_EXTERNAL_PARAMETER_ENTITY</a> = 5
80*7c568831SAndroid Build Coastguard Worker    <a name="XML_INTERNAL_PREDEFINED_ENTITY">XML_INTERNAL_PREDEFINED_ENTITY</a> = 6
81*7c568831SAndroid Build Coastguard Worker};
82*7c568831SAndroid Build Coastguard Worker</pre>
83*7c568831SAndroid Build Coastguard Worker<p></p>
84*7c568831SAndroid Build Coastguard Worker</div>
85*7c568831SAndroid Build Coastguard Worker<hr>
86*7c568831SAndroid Build Coastguard Worker<div class="refsect2" lang="en">
87*7c568831SAndroid Build Coastguard Worker<h3>
88*7c568831SAndroid Build Coastguard Worker<a name="xmlAddDocEntity"></a>xmlAddDocEntity ()</h3>
89*7c568831SAndroid Build Coastguard Worker<pre class="programlisting"><a href="libxml2-tree.html#xmlEntityPtr">xmlEntityPtr</a>	xmlAddDocEntity		(<a href="libxml2-tree.html#xmlDocPtr">xmlDocPtr</a> doc, <br>					 const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name, <br>					 int type, <br>					 const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * ExternalID, <br>					 const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * SystemID, <br>					 const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * content)<br>
90*7c568831SAndroid Build Coastguard Worker</pre>
91*7c568831SAndroid Build Coastguard Worker<p>Register a new entity for this document.</p>
92*7c568831SAndroid Build Coastguard Worker<div class="variablelist"><table border="0">
93*7c568831SAndroid Build Coastguard Worker<col align="left">
94*7c568831SAndroid Build Coastguard Worker<tbody>
95*7c568831SAndroid Build Coastguard Worker<tr>
96*7c568831SAndroid Build Coastguard Worker<td><span class="term"><i><tt>doc</tt></i>:</span></td>
97*7c568831SAndroid Build Coastguard Worker<td>the document</td>
98*7c568831SAndroid Build Coastguard Worker</tr>
99*7c568831SAndroid Build Coastguard Worker<tr>
100*7c568831SAndroid Build Coastguard Worker<td><span class="term"><i><tt>name</tt></i>:</span></td>
101*7c568831SAndroid Build Coastguard Worker<td>the entity name</td>
102*7c568831SAndroid Build Coastguard Worker</tr>
103*7c568831SAndroid Build Coastguard Worker<tr>
104*7c568831SAndroid Build Coastguard Worker<td><span class="term"><i><tt>type</tt></i>:</span></td>
105*7c568831SAndroid Build Coastguard Worker<td>the entity type XML_xxx_yyy_ENTITY</td>
106*7c568831SAndroid Build Coastguard Worker</tr>
107*7c568831SAndroid Build Coastguard Worker<tr>
108*7c568831SAndroid Build Coastguard Worker<td><span class="term"><i><tt>ExternalID</tt></i>:</span></td>
109*7c568831SAndroid Build Coastguard Worker<td>the entity external ID if available</td>
110*7c568831SAndroid Build Coastguard Worker</tr>
111*7c568831SAndroid Build Coastguard Worker<tr>
112*7c568831SAndroid Build Coastguard Worker<td><span class="term"><i><tt>SystemID</tt></i>:</span></td>
113*7c568831SAndroid Build Coastguard Worker<td>the entity system ID if available</td>
114*7c568831SAndroid Build Coastguard Worker</tr>
115*7c568831SAndroid Build Coastguard Worker<tr>
116*7c568831SAndroid Build Coastguard Worker<td><span class="term"><i><tt>content</tt></i>:</span></td>
117*7c568831SAndroid Build Coastguard Worker<td>the entity content</td>
118*7c568831SAndroid Build Coastguard Worker</tr>
119*7c568831SAndroid Build Coastguard Worker<tr>
120*7c568831SAndroid Build Coastguard Worker<td><span class="term"><i><tt>Returns</tt></i>:</span></td>
121*7c568831SAndroid Build Coastguard Worker<td>a pointer to the entity or NULL in case of error</td>
122*7c568831SAndroid Build Coastguard Worker</tr>
123*7c568831SAndroid Build Coastguard Worker</tbody>
124*7c568831SAndroid Build Coastguard Worker</table></div>
125*7c568831SAndroid Build Coastguard Worker</div>
126*7c568831SAndroid Build Coastguard Worker<hr>
127*7c568831SAndroid Build Coastguard Worker<div class="refsect2" lang="en">
128*7c568831SAndroid Build Coastguard Worker<h3>
129*7c568831SAndroid Build Coastguard Worker<a name="xmlAddDtdEntity"></a>xmlAddDtdEntity ()</h3>
130*7c568831SAndroid Build Coastguard Worker<pre class="programlisting"><a href="libxml2-tree.html#xmlEntityPtr">xmlEntityPtr</a>	xmlAddDtdEntity		(<a href="libxml2-tree.html#xmlDocPtr">xmlDocPtr</a> doc, <br>					 const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name, <br>					 int type, <br>					 const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * ExternalID, <br>					 const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * SystemID, <br>					 const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * content)<br>
131*7c568831SAndroid Build Coastguard Worker</pre>
132*7c568831SAndroid Build Coastguard Worker<p>Register a new entity for this document DTD external subset.</p>
133*7c568831SAndroid Build Coastguard Worker<div class="variablelist"><table border="0">
134*7c568831SAndroid Build Coastguard Worker<col align="left">
135*7c568831SAndroid Build Coastguard Worker<tbody>
136*7c568831SAndroid Build Coastguard Worker<tr>
137*7c568831SAndroid Build Coastguard Worker<td><span class="term"><i><tt>doc</tt></i>:</span></td>
138*7c568831SAndroid Build Coastguard Worker<td>the document</td>
139*7c568831SAndroid Build Coastguard Worker</tr>
140*7c568831SAndroid Build Coastguard Worker<tr>
141*7c568831SAndroid Build Coastguard Worker<td><span class="term"><i><tt>name</tt></i>:</span></td>
142*7c568831SAndroid Build Coastguard Worker<td>the entity name</td>
143*7c568831SAndroid Build Coastguard Worker</tr>
144*7c568831SAndroid Build Coastguard Worker<tr>
145*7c568831SAndroid Build Coastguard Worker<td><span class="term"><i><tt>type</tt></i>:</span></td>
146*7c568831SAndroid Build Coastguard Worker<td>the entity type XML_xxx_yyy_ENTITY</td>
147*7c568831SAndroid Build Coastguard Worker</tr>
148*7c568831SAndroid Build Coastguard Worker<tr>
149*7c568831SAndroid Build Coastguard Worker<td><span class="term"><i><tt>ExternalID</tt></i>:</span></td>
150*7c568831SAndroid Build Coastguard Worker<td>the entity external ID if available</td>
151*7c568831SAndroid Build Coastguard Worker</tr>
152*7c568831SAndroid Build Coastguard Worker<tr>
153*7c568831SAndroid Build Coastguard Worker<td><span class="term"><i><tt>SystemID</tt></i>:</span></td>
154*7c568831SAndroid Build Coastguard Worker<td>the entity system ID if available</td>
155*7c568831SAndroid Build Coastguard Worker</tr>
156*7c568831SAndroid Build Coastguard Worker<tr>
157*7c568831SAndroid Build Coastguard Worker<td><span class="term"><i><tt>content</tt></i>:</span></td>
158*7c568831SAndroid Build Coastguard Worker<td>the entity content</td>
159*7c568831SAndroid Build Coastguard Worker</tr>
160*7c568831SAndroid Build Coastguard Worker<tr>
161*7c568831SAndroid Build Coastguard Worker<td><span class="term"><i><tt>Returns</tt></i>:</span></td>
162*7c568831SAndroid Build Coastguard Worker<td>a pointer to the entity or NULL in case of error</td>
163*7c568831SAndroid Build Coastguard Worker</tr>
164*7c568831SAndroid Build Coastguard Worker</tbody>
165*7c568831SAndroid Build Coastguard Worker</table></div>
166*7c568831SAndroid Build Coastguard Worker</div>
167*7c568831SAndroid Build Coastguard Worker<hr>
168*7c568831SAndroid Build Coastguard Worker<div class="refsect2" lang="en">
169*7c568831SAndroid Build Coastguard Worker<h3>
170*7c568831SAndroid Build Coastguard Worker<a name="xmlAddEntity"></a>xmlAddEntity ()</h3>
171*7c568831SAndroid Build Coastguard Worker<pre class="programlisting">int	xmlAddEntity			(<a href="libxml2-tree.html#xmlDocPtr">xmlDocPtr</a> doc, <br>					 int extSubset, <br>					 const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name, <br>					 int type, <br>					 const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * ExternalID, <br>					 const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * SystemID, <br>					 const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * content, <br>					 <a href="libxml2-tree.html#xmlEntityPtr">xmlEntityPtr</a> * out)<br>
172*7c568831SAndroid Build Coastguard Worker</pre>
173*7c568831SAndroid Build Coastguard Worker<p>Register a new entity for this document. Available since 2.13.0.</p>
174*7c568831SAndroid Build Coastguard Worker<div class="variablelist"><table border="0">
175*7c568831SAndroid Build Coastguard Worker<col align="left">
176*7c568831SAndroid Build Coastguard Worker<tbody>
177*7c568831SAndroid Build Coastguard Worker<tr>
178*7c568831SAndroid Build Coastguard Worker<td><span class="term"><i><tt>doc</tt></i>:</span></td>
179*7c568831SAndroid Build Coastguard Worker<td>the document</td>
180*7c568831SAndroid Build Coastguard Worker</tr>
181*7c568831SAndroid Build Coastguard Worker<tr>
182*7c568831SAndroid Build Coastguard Worker<td><span class="term"><i><tt>extSubset</tt></i>:</span></td>
183*7c568831SAndroid Build Coastguard Worker<td>add to the external or internal subset</td>
184*7c568831SAndroid Build Coastguard Worker</tr>
185*7c568831SAndroid Build Coastguard Worker<tr>
186*7c568831SAndroid Build Coastguard Worker<td><span class="term"><i><tt>name</tt></i>:</span></td>
187*7c568831SAndroid Build Coastguard Worker<td>the entity name</td>
188*7c568831SAndroid Build Coastguard Worker</tr>
189*7c568831SAndroid Build Coastguard Worker<tr>
190*7c568831SAndroid Build Coastguard Worker<td><span class="term"><i><tt>type</tt></i>:</span></td>
191*7c568831SAndroid Build Coastguard Worker<td>the entity type XML_xxx_yyy_ENTITY</td>
192*7c568831SAndroid Build Coastguard Worker</tr>
193*7c568831SAndroid Build Coastguard Worker<tr>
194*7c568831SAndroid Build Coastguard Worker<td><span class="term"><i><tt>ExternalID</tt></i>:</span></td>
195*7c568831SAndroid Build Coastguard Worker<td>the entity external ID if available</td>
196*7c568831SAndroid Build Coastguard Worker</tr>
197*7c568831SAndroid Build Coastguard Worker<tr>
198*7c568831SAndroid Build Coastguard Worker<td><span class="term"><i><tt>SystemID</tt></i>:</span></td>
199*7c568831SAndroid Build Coastguard Worker<td>the entity system ID if available</td>
200*7c568831SAndroid Build Coastguard Worker</tr>
201*7c568831SAndroid Build Coastguard Worker<tr>
202*7c568831SAndroid Build Coastguard Worker<td><span class="term"><i><tt>content</tt></i>:</span></td>
203*7c568831SAndroid Build Coastguard Worker<td>the entity content</td>
204*7c568831SAndroid Build Coastguard Worker</tr>
205*7c568831SAndroid Build Coastguard Worker<tr>
206*7c568831SAndroid Build Coastguard Worker<td><span class="term"><i><tt>out</tt></i>:</span></td>
207*7c568831SAndroid Build Coastguard Worker<td>pointer to resulting entity (optional)</td>
208*7c568831SAndroid Build Coastguard Worker</tr>
209*7c568831SAndroid Build Coastguard Worker<tr>
210*7c568831SAndroid Build Coastguard Worker<td><span class="term"><i><tt>Returns</tt></i>:</span></td>
211*7c568831SAndroid Build Coastguard Worker<td>an <a href="libxml2-xmlerror.html#xmlParserErrors">xmlParserErrors</a> error code.</td>
212*7c568831SAndroid Build Coastguard Worker</tr>
213*7c568831SAndroid Build Coastguard Worker</tbody>
214*7c568831SAndroid Build Coastguard Worker</table></div>
215*7c568831SAndroid Build Coastguard Worker</div>
216*7c568831SAndroid Build Coastguard Worker<hr>
217*7c568831SAndroid Build Coastguard Worker<div class="refsect2" lang="en">
218*7c568831SAndroid Build Coastguard Worker<h3>
219*7c568831SAndroid Build Coastguard Worker<a name="xmlCleanupPredefinedEntities"></a>xmlCleanupPredefinedEntities ()</h3>
220*7c568831SAndroid Build Coastguard Worker<pre class="programlisting">void	xmlCleanupPredefinedEntities	(void)<br>
221*7c568831SAndroid Build Coastguard Worker</pre>
222*7c568831SAndroid Build Coastguard Worker<p>Cleanup up the predefined entities table. Deprecated call</p>
223*7c568831SAndroid Build Coastguard Worker</div>
224*7c568831SAndroid Build Coastguard Worker<hr>
225*7c568831SAndroid Build Coastguard Worker<div class="refsect2" lang="en">
226*7c568831SAndroid Build Coastguard Worker<h3>
227*7c568831SAndroid Build Coastguard Worker<a name="xmlCopyEntitiesTable"></a>xmlCopyEntitiesTable ()</h3>
228*7c568831SAndroid Build Coastguard Worker<pre class="programlisting"><a href="libxml2-entities.html#xmlEntitiesTablePtr">xmlEntitiesTablePtr</a>	xmlCopyEntitiesTable	(<a href="libxml2-entities.html#xmlEntitiesTablePtr">xmlEntitiesTablePtr</a> table)<br>
229*7c568831SAndroid Build Coastguard Worker</pre>
230*7c568831SAndroid Build Coastguard Worker<p>Build a copy of an entity table.</p>
231*7c568831SAndroid Build Coastguard Worker<div class="variablelist"><table border="0">
232*7c568831SAndroid Build Coastguard Worker<col align="left">
233*7c568831SAndroid Build Coastguard Worker<tbody>
234*7c568831SAndroid Build Coastguard Worker<tr>
235*7c568831SAndroid Build Coastguard Worker<td><span class="term"><i><tt>table</tt></i>:</span></td>
236*7c568831SAndroid Build Coastguard Worker<td>An entity table</td>
237*7c568831SAndroid Build Coastguard Worker</tr>
238*7c568831SAndroid Build Coastguard Worker<tr>
239*7c568831SAndroid Build Coastguard Worker<td><span class="term"><i><tt>Returns</tt></i>:</span></td>
240*7c568831SAndroid Build Coastguard Worker<td>the new <a href="libxml2-entities.html#xmlEntitiesTablePtr">xmlEntitiesTablePtr</a> or NULL in case of error.</td>
241*7c568831SAndroid Build Coastguard Worker</tr>
242*7c568831SAndroid Build Coastguard Worker</tbody>
243*7c568831SAndroid Build Coastguard Worker</table></div>
244*7c568831SAndroid Build Coastguard Worker</div>
245*7c568831SAndroid Build Coastguard Worker<hr>
246*7c568831SAndroid Build Coastguard Worker<div class="refsect2" lang="en">
247*7c568831SAndroid Build Coastguard Worker<h3>
248*7c568831SAndroid Build Coastguard Worker<a name="xmlCreateEntitiesTable"></a>xmlCreateEntitiesTable ()</h3>
249*7c568831SAndroid Build Coastguard Worker<pre class="programlisting"><a href="libxml2-entities.html#xmlEntitiesTablePtr">xmlEntitiesTablePtr</a>	xmlCreateEntitiesTable	(void)<br>
250*7c568831SAndroid Build Coastguard Worker</pre>
251*7c568831SAndroid Build Coastguard Worker<p>create and initialize an empty entities hash table. This really doesn't make sense and should be deprecated</p>
252*7c568831SAndroid Build Coastguard Worker<div class="variablelist"><table border="0">
253*7c568831SAndroid Build Coastguard Worker<col align="left">
254*7c568831SAndroid Build Coastguard Worker<tbody><tr>
255*7c568831SAndroid Build Coastguard Worker<td><span class="term"><i><tt>Returns</tt></i>:</span></td>
256*7c568831SAndroid Build Coastguard Worker<td>the <a href="libxml2-entities.html#xmlEntitiesTablePtr">xmlEntitiesTablePtr</a> just created or NULL in case of error.</td>
257*7c568831SAndroid Build Coastguard Worker</tr></tbody>
258*7c568831SAndroid Build Coastguard Worker</table></div>
259*7c568831SAndroid Build Coastguard Worker</div>
260*7c568831SAndroid Build Coastguard Worker<hr>
261*7c568831SAndroid Build Coastguard Worker<div class="refsect2" lang="en">
262*7c568831SAndroid Build Coastguard Worker<h3>
263*7c568831SAndroid Build Coastguard Worker<a name="xmlDumpEntitiesTable"></a>xmlDumpEntitiesTable ()</h3>
264*7c568831SAndroid Build Coastguard Worker<pre class="programlisting">void	xmlDumpEntitiesTable		(<a href="libxml2-tree.html#xmlBufferPtr">xmlBufferPtr</a> buf, <br>					 <a href="libxml2-entities.html#xmlEntitiesTablePtr">xmlEntitiesTablePtr</a> table)<br>
265*7c568831SAndroid Build Coastguard Worker</pre>
266*7c568831SAndroid Build Coastguard Worker<p>This will dump the content of the entity table as an XML DTD definition</p>
267*7c568831SAndroid Build Coastguard Worker<div class="variablelist"><table border="0">
268*7c568831SAndroid Build Coastguard Worker<col align="left">
269*7c568831SAndroid Build Coastguard Worker<tbody>
270*7c568831SAndroid Build Coastguard Worker<tr>
271*7c568831SAndroid Build Coastguard Worker<td><span class="term"><i><tt>buf</tt></i>:</span></td>
272*7c568831SAndroid Build Coastguard Worker<td>An XML buffer.</td>
273*7c568831SAndroid Build Coastguard Worker</tr>
274*7c568831SAndroid Build Coastguard Worker<tr>
275*7c568831SAndroid Build Coastguard Worker<td><span class="term"><i><tt>table</tt></i>:</span></td>
276*7c568831SAndroid Build Coastguard Worker<td>An entity table</td>
277*7c568831SAndroid Build Coastguard Worker</tr>
278*7c568831SAndroid Build Coastguard Worker</tbody>
279*7c568831SAndroid Build Coastguard Worker</table></div>
280*7c568831SAndroid Build Coastguard Worker</div>
281*7c568831SAndroid Build Coastguard Worker<hr>
282*7c568831SAndroid Build Coastguard Worker<div class="refsect2" lang="en">
283*7c568831SAndroid Build Coastguard Worker<h3>
284*7c568831SAndroid Build Coastguard Worker<a name="xmlDumpEntityDecl"></a>xmlDumpEntityDecl ()</h3>
285*7c568831SAndroid Build Coastguard Worker<pre class="programlisting">void	xmlDumpEntityDecl		(<a href="libxml2-tree.html#xmlBufferPtr">xmlBufferPtr</a> buf, <br>					 <a href="libxml2-tree.html#xmlEntityPtr">xmlEntityPtr</a> ent)<br>
286*7c568831SAndroid Build Coastguard Worker</pre>
287*7c568831SAndroid Build Coastguard Worker<p>This will dump the content of the entity table as an XML DTD definition</p>
288*7c568831SAndroid Build Coastguard Worker<div class="variablelist"><table border="0">
289*7c568831SAndroid Build Coastguard Worker<col align="left">
290*7c568831SAndroid Build Coastguard Worker<tbody>
291*7c568831SAndroid Build Coastguard Worker<tr>
292*7c568831SAndroid Build Coastguard Worker<td><span class="term"><i><tt>buf</tt></i>:</span></td>
293*7c568831SAndroid Build Coastguard Worker<td>An XML buffer.</td>
294*7c568831SAndroid Build Coastguard Worker</tr>
295*7c568831SAndroid Build Coastguard Worker<tr>
296*7c568831SAndroid Build Coastguard Worker<td><span class="term"><i><tt>ent</tt></i>:</span></td>
297*7c568831SAndroid Build Coastguard Worker<td>An entity table</td>
298*7c568831SAndroid Build Coastguard Worker</tr>
299*7c568831SAndroid Build Coastguard Worker</tbody>
300*7c568831SAndroid Build Coastguard Worker</table></div>
301*7c568831SAndroid Build Coastguard Worker</div>
302*7c568831SAndroid Build Coastguard Worker<hr>
303*7c568831SAndroid Build Coastguard Worker<div class="refsect2" lang="en">
304*7c568831SAndroid Build Coastguard Worker<h3>
305*7c568831SAndroid Build Coastguard Worker<a name="xmlEncodeEntities"></a>xmlEncodeEntities ()</h3>
306*7c568831SAndroid Build Coastguard Worker<pre class="programlisting">const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> *	xmlEncodeEntities	(<a href="libxml2-tree.html#xmlDocPtr">xmlDocPtr</a> doc, <br>					 const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * input)<br>
307*7c568831SAndroid Build Coastguard Worker</pre>
308*7c568831SAndroid Build Coastguard Worker<p>TODO: remove xmlEncodeEntities, once we are not afraid of breaking binary compatibility People must migrate their code to <a href="libxml2-entities.html#xmlEncodeEntitiesReentrant">xmlEncodeEntitiesReentrant</a> ! This routine will issue a warning when encountered.</p>
309*7c568831SAndroid Build Coastguard Worker<div class="variablelist"><table border="0">
310*7c568831SAndroid Build Coastguard Worker<col align="left">
311*7c568831SAndroid Build Coastguard Worker<tbody>
312*7c568831SAndroid Build Coastguard Worker<tr>
313*7c568831SAndroid Build Coastguard Worker<td><span class="term"><i><tt>doc</tt></i>:</span></td>
314*7c568831SAndroid Build Coastguard Worker<td>the document containing the string</td>
315*7c568831SAndroid Build Coastguard Worker</tr>
316*7c568831SAndroid Build Coastguard Worker<tr>
317*7c568831SAndroid Build Coastguard Worker<td><span class="term"><i><tt>input</tt></i>:</span></td>
318*7c568831SAndroid Build Coastguard Worker<td>A string to convert to XML.</td>
319*7c568831SAndroid Build Coastguard Worker</tr>
320*7c568831SAndroid Build Coastguard Worker<tr>
321*7c568831SAndroid Build Coastguard Worker<td><span class="term"><i><tt>Returns</tt></i>:</span></td>
322*7c568831SAndroid Build Coastguard Worker<td>NULL</td>
323*7c568831SAndroid Build Coastguard Worker</tr>
324*7c568831SAndroid Build Coastguard Worker</tbody>
325*7c568831SAndroid Build Coastguard Worker</table></div>
326*7c568831SAndroid Build Coastguard Worker</div>
327*7c568831SAndroid Build Coastguard Worker<hr>
328*7c568831SAndroid Build Coastguard Worker<div class="refsect2" lang="en">
329*7c568831SAndroid Build Coastguard Worker<h3>
330*7c568831SAndroid Build Coastguard Worker<a name="xmlEncodeEntitiesReentrant"></a>xmlEncodeEntitiesReentrant ()</h3>
331*7c568831SAndroid Build Coastguard Worker<pre class="programlisting"><a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> *	xmlEncodeEntitiesReentrant	(<a href="libxml2-tree.html#xmlDocPtr">xmlDocPtr</a> doc, <br>						 const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * input)<br>
332*7c568831SAndroid Build Coastguard Worker</pre>
333*7c568831SAndroid Build Coastguard Worker<p>Do a global encoding of a string, replacing the predefined entities and non ASCII values with their entities and CharRef counterparts. Contrary to xmlEncodeEntities, this routine is reentrant, and result must be deallocated.</p>
334*7c568831SAndroid Build Coastguard Worker<div class="variablelist"><table border="0">
335*7c568831SAndroid Build Coastguard Worker<col align="left">
336*7c568831SAndroid Build Coastguard Worker<tbody>
337*7c568831SAndroid Build Coastguard Worker<tr>
338*7c568831SAndroid Build Coastguard Worker<td><span class="term"><i><tt>doc</tt></i>:</span></td>
339*7c568831SAndroid Build Coastguard Worker<td>the document containing the string</td>
340*7c568831SAndroid Build Coastguard Worker</tr>
341*7c568831SAndroid Build Coastguard Worker<tr>
342*7c568831SAndroid Build Coastguard Worker<td><span class="term"><i><tt>input</tt></i>:</span></td>
343*7c568831SAndroid Build Coastguard Worker<td>A string to convert to XML.</td>
344*7c568831SAndroid Build Coastguard Worker</tr>
345*7c568831SAndroid Build Coastguard Worker<tr>
346*7c568831SAndroid Build Coastguard Worker<td><span class="term"><i><tt>Returns</tt></i>:</span></td>
347*7c568831SAndroid Build Coastguard Worker<td>A newly allocated string with the substitution done.</td>
348*7c568831SAndroid Build Coastguard Worker</tr>
349*7c568831SAndroid Build Coastguard Worker</tbody>
350*7c568831SAndroid Build Coastguard Worker</table></div>
351*7c568831SAndroid Build Coastguard Worker</div>
352*7c568831SAndroid Build Coastguard Worker<hr>
353*7c568831SAndroid Build Coastguard Worker<div class="refsect2" lang="en">
354*7c568831SAndroid Build Coastguard Worker<h3>
355*7c568831SAndroid Build Coastguard Worker<a name="xmlEncodeSpecialChars"></a>xmlEncodeSpecialChars ()</h3>
356*7c568831SAndroid Build Coastguard Worker<pre class="programlisting"><a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> *	xmlEncodeSpecialChars	(const <a href="libxml2-tree.html#xmlDoc">xmlDoc</a> * doc, <br>					 const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * input)<br>
357*7c568831SAndroid Build Coastguard Worker</pre>
358*7c568831SAndroid Build Coastguard Worker<p>Do a global encoding of a string, replacing the predefined entities this routine is reentrant, and result must be deallocated.</p>
359*7c568831SAndroid Build Coastguard Worker<div class="variablelist"><table border="0">
360*7c568831SAndroid Build Coastguard Worker<col align="left">
361*7c568831SAndroid Build Coastguard Worker<tbody>
362*7c568831SAndroid Build Coastguard Worker<tr>
363*7c568831SAndroid Build Coastguard Worker<td><span class="term"><i><tt>doc</tt></i>:</span></td>
364*7c568831SAndroid Build Coastguard Worker<td>the document containing the string</td>
365*7c568831SAndroid Build Coastguard Worker</tr>
366*7c568831SAndroid Build Coastguard Worker<tr>
367*7c568831SAndroid Build Coastguard Worker<td><span class="term"><i><tt>input</tt></i>:</span></td>
368*7c568831SAndroid Build Coastguard Worker<td>A string to convert to XML.</td>
369*7c568831SAndroid Build Coastguard Worker</tr>
370*7c568831SAndroid Build Coastguard Worker<tr>
371*7c568831SAndroid Build Coastguard Worker<td><span class="term"><i><tt>Returns</tt></i>:</span></td>
372*7c568831SAndroid Build Coastguard Worker<td>A newly allocated string with the substitution done.</td>
373*7c568831SAndroid Build Coastguard Worker</tr>
374*7c568831SAndroid Build Coastguard Worker</tbody>
375*7c568831SAndroid Build Coastguard Worker</table></div>
376*7c568831SAndroid Build Coastguard Worker</div>
377*7c568831SAndroid Build Coastguard Worker<hr>
378*7c568831SAndroid Build Coastguard Worker<div class="refsect2" lang="en">
379*7c568831SAndroid Build Coastguard Worker<h3>
380*7c568831SAndroid Build Coastguard Worker<a name="xmlFreeEntitiesTable"></a>xmlFreeEntitiesTable ()</h3>
381*7c568831SAndroid Build Coastguard Worker<pre class="programlisting">void	xmlFreeEntitiesTable		(<a href="libxml2-entities.html#xmlEntitiesTablePtr">xmlEntitiesTablePtr</a> table)<br>
382*7c568831SAndroid Build Coastguard Worker</pre>
383*7c568831SAndroid Build Coastguard Worker<p>Deallocate the memory used by an entities hash table.</p>
384*7c568831SAndroid Build Coastguard Worker<div class="variablelist"><table border="0">
385*7c568831SAndroid Build Coastguard Worker<col align="left">
386*7c568831SAndroid Build Coastguard Worker<tbody><tr>
387*7c568831SAndroid Build Coastguard Worker<td><span class="term"><i><tt>table</tt></i>:</span></td>
388*7c568831SAndroid Build Coastguard Worker<td>An entity table</td>
389*7c568831SAndroid Build Coastguard Worker</tr></tbody>
390*7c568831SAndroid Build Coastguard Worker</table></div>
391*7c568831SAndroid Build Coastguard Worker</div>
392*7c568831SAndroid Build Coastguard Worker<hr>
393*7c568831SAndroid Build Coastguard Worker<div class="refsect2" lang="en">
394*7c568831SAndroid Build Coastguard Worker<h3>
395*7c568831SAndroid Build Coastguard Worker<a name="xmlFreeEntity"></a>xmlFreeEntity ()</h3>
396*7c568831SAndroid Build Coastguard Worker<pre class="programlisting">void	xmlFreeEntity			(<a href="libxml2-tree.html#xmlEntityPtr">xmlEntityPtr</a> entity)<br>
397*7c568831SAndroid Build Coastguard Worker</pre>
398*7c568831SAndroid Build Coastguard Worker<p>Frees the entity.</p>
399*7c568831SAndroid Build Coastguard Worker<div class="variablelist"><table border="0">
400*7c568831SAndroid Build Coastguard Worker<col align="left">
401*7c568831SAndroid Build Coastguard Worker<tbody><tr>
402*7c568831SAndroid Build Coastguard Worker<td><span class="term"><i><tt>entity</tt></i>:</span></td>
403*7c568831SAndroid Build Coastguard Worker<td>an entity</td>
404*7c568831SAndroid Build Coastguard Worker</tr></tbody>
405*7c568831SAndroid Build Coastguard Worker</table></div>
406*7c568831SAndroid Build Coastguard Worker</div>
407*7c568831SAndroid Build Coastguard Worker<hr>
408*7c568831SAndroid Build Coastguard Worker<div class="refsect2" lang="en">
409*7c568831SAndroid Build Coastguard Worker<h3>
410*7c568831SAndroid Build Coastguard Worker<a name="xmlGetDocEntity"></a>xmlGetDocEntity ()</h3>
411*7c568831SAndroid Build Coastguard Worker<pre class="programlisting"><a href="libxml2-tree.html#xmlEntityPtr">xmlEntityPtr</a>	xmlGetDocEntity		(const <a href="libxml2-tree.html#xmlDoc">xmlDoc</a> * doc, <br>					 const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name)<br>
412*7c568831SAndroid Build Coastguard Worker</pre>
413*7c568831SAndroid Build Coastguard Worker<p>Do an entity lookup in the document entity hash table and</p>
414*7c568831SAndroid Build Coastguard Worker<div class="variablelist"><table border="0">
415*7c568831SAndroid Build Coastguard Worker<col align="left">
416*7c568831SAndroid Build Coastguard Worker<tbody>
417*7c568831SAndroid Build Coastguard Worker<tr>
418*7c568831SAndroid Build Coastguard Worker<td><span class="term"><i><tt>doc</tt></i>:</span></td>
419*7c568831SAndroid Build Coastguard Worker<td>the document referencing the entity</td>
420*7c568831SAndroid Build Coastguard Worker</tr>
421*7c568831SAndroid Build Coastguard Worker<tr>
422*7c568831SAndroid Build Coastguard Worker<td><span class="term"><i><tt>name</tt></i>:</span></td>
423*7c568831SAndroid Build Coastguard Worker<td>the entity name</td>
424*7c568831SAndroid Build Coastguard Worker</tr>
425*7c568831SAndroid Build Coastguard Worker<tr>
426*7c568831SAndroid Build Coastguard Worker<td><span class="term"><i><tt>Returns</tt></i>:</span></td>
427*7c568831SAndroid Build Coastguard Worker<td>the corresponding entity, otherwise a lookup is done in the predefined entities too. Returns A pointer to the entity structure or NULL if not found.</td>
428*7c568831SAndroid Build Coastguard Worker</tr>
429*7c568831SAndroid Build Coastguard Worker</tbody>
430*7c568831SAndroid Build Coastguard Worker</table></div>
431*7c568831SAndroid Build Coastguard Worker</div>
432*7c568831SAndroid Build Coastguard Worker<hr>
433*7c568831SAndroid Build Coastguard Worker<div class="refsect2" lang="en">
434*7c568831SAndroid Build Coastguard Worker<h3>
435*7c568831SAndroid Build Coastguard Worker<a name="xmlGetDtdEntity"></a>xmlGetDtdEntity ()</h3>
436*7c568831SAndroid Build Coastguard Worker<pre class="programlisting"><a href="libxml2-tree.html#xmlEntityPtr">xmlEntityPtr</a>	xmlGetDtdEntity		(<a href="libxml2-tree.html#xmlDocPtr">xmlDocPtr</a> doc, <br>					 const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name)<br>
437*7c568831SAndroid Build Coastguard Worker</pre>
438*7c568831SAndroid Build Coastguard Worker<p>Do an entity lookup in the DTD entity hash table and</p>
439*7c568831SAndroid Build Coastguard Worker<div class="variablelist"><table border="0">
440*7c568831SAndroid Build Coastguard Worker<col align="left">
441*7c568831SAndroid Build Coastguard Worker<tbody>
442*7c568831SAndroid Build Coastguard Worker<tr>
443*7c568831SAndroid Build Coastguard Worker<td><span class="term"><i><tt>doc</tt></i>:</span></td>
444*7c568831SAndroid Build Coastguard Worker<td>the document referencing the entity</td>
445*7c568831SAndroid Build Coastguard Worker</tr>
446*7c568831SAndroid Build Coastguard Worker<tr>
447*7c568831SAndroid Build Coastguard Worker<td><span class="term"><i><tt>name</tt></i>:</span></td>
448*7c568831SAndroid Build Coastguard Worker<td>the entity name</td>
449*7c568831SAndroid Build Coastguard Worker</tr>
450*7c568831SAndroid Build Coastguard Worker<tr>
451*7c568831SAndroid Build Coastguard Worker<td><span class="term"><i><tt>Returns</tt></i>:</span></td>
452*7c568831SAndroid Build Coastguard Worker<td>the corresponding entity, if found. Note: the first argument is the document node, not the DTD node. Returns A pointer to the entity structure or NULL if not found.</td>
453*7c568831SAndroid Build Coastguard Worker</tr>
454*7c568831SAndroid Build Coastguard Worker</tbody>
455*7c568831SAndroid Build Coastguard Worker</table></div>
456*7c568831SAndroid Build Coastguard Worker</div>
457*7c568831SAndroid Build Coastguard Worker<hr>
458*7c568831SAndroid Build Coastguard Worker<div class="refsect2" lang="en">
459*7c568831SAndroid Build Coastguard Worker<h3>
460*7c568831SAndroid Build Coastguard Worker<a name="xmlGetParameterEntity"></a>xmlGetParameterEntity ()</h3>
461*7c568831SAndroid Build Coastguard Worker<pre class="programlisting"><a href="libxml2-tree.html#xmlEntityPtr">xmlEntityPtr</a>	xmlGetParameterEntity	(<a href="libxml2-tree.html#xmlDocPtr">xmlDocPtr</a> doc, <br>					 const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name)<br>
462*7c568831SAndroid Build Coastguard Worker</pre>
463*7c568831SAndroid Build Coastguard Worker<p>Do an entity lookup in the internal and external subsets and</p>
464*7c568831SAndroid Build Coastguard Worker<div class="variablelist"><table border="0">
465*7c568831SAndroid Build Coastguard Worker<col align="left">
466*7c568831SAndroid Build Coastguard Worker<tbody>
467*7c568831SAndroid Build Coastguard Worker<tr>
468*7c568831SAndroid Build Coastguard Worker<td><span class="term"><i><tt>doc</tt></i>:</span></td>
469*7c568831SAndroid Build Coastguard Worker<td>the document referencing the entity</td>
470*7c568831SAndroid Build Coastguard Worker</tr>
471*7c568831SAndroid Build Coastguard Worker<tr>
472*7c568831SAndroid Build Coastguard Worker<td><span class="term"><i><tt>name</tt></i>:</span></td>
473*7c568831SAndroid Build Coastguard Worker<td>the entity name</td>
474*7c568831SAndroid Build Coastguard Worker</tr>
475*7c568831SAndroid Build Coastguard Worker<tr>
476*7c568831SAndroid Build Coastguard Worker<td><span class="term"><i><tt>Returns</tt></i>:</span></td>
477*7c568831SAndroid Build Coastguard Worker<td>the corresponding parameter entity, if found. Returns A pointer to the entity structure or NULL if not found.</td>
478*7c568831SAndroid Build Coastguard Worker</tr>
479*7c568831SAndroid Build Coastguard Worker</tbody>
480*7c568831SAndroid Build Coastguard Worker</table></div>
481*7c568831SAndroid Build Coastguard Worker</div>
482*7c568831SAndroid Build Coastguard Worker<hr>
483*7c568831SAndroid Build Coastguard Worker<div class="refsect2" lang="en">
484*7c568831SAndroid Build Coastguard Worker<h3>
485*7c568831SAndroid Build Coastguard Worker<a name="xmlGetPredefinedEntity"></a>xmlGetPredefinedEntity ()</h3>
486*7c568831SAndroid Build Coastguard Worker<pre class="programlisting"><a href="libxml2-tree.html#xmlEntityPtr">xmlEntityPtr</a>	xmlGetPredefinedEntity	(const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name)<br>
487*7c568831SAndroid Build Coastguard Worker</pre>
488*7c568831SAndroid Build Coastguard Worker<p>Check whether this name is an predefined entity.</p>
489*7c568831SAndroid Build Coastguard Worker<div class="variablelist"><table border="0">
490*7c568831SAndroid Build Coastguard Worker<col align="left">
491*7c568831SAndroid Build Coastguard Worker<tbody>
492*7c568831SAndroid Build Coastguard Worker<tr>
493*7c568831SAndroid Build Coastguard Worker<td><span class="term"><i><tt>name</tt></i>:</span></td>
494*7c568831SAndroid Build Coastguard Worker<td>the entity name</td>
495*7c568831SAndroid Build Coastguard Worker</tr>
496*7c568831SAndroid Build Coastguard Worker<tr>
497*7c568831SAndroid Build Coastguard Worker<td><span class="term"><i><tt>Returns</tt></i>:</span></td>
498*7c568831SAndroid Build Coastguard Worker<td>NULL if not, otherwise the entity</td>
499*7c568831SAndroid Build Coastguard Worker</tr>
500*7c568831SAndroid Build Coastguard Worker</tbody>
501*7c568831SAndroid Build Coastguard Worker</table></div>
502*7c568831SAndroid Build Coastguard Worker</div>
503*7c568831SAndroid Build Coastguard Worker<hr>
504*7c568831SAndroid Build Coastguard Worker<div class="refsect2" lang="en">
505*7c568831SAndroid Build Coastguard Worker<h3>
506*7c568831SAndroid Build Coastguard Worker<a name="xmlInitializePredefinedEntities"></a>xmlInitializePredefinedEntities ()</h3>
507*7c568831SAndroid Build Coastguard Worker<pre class="programlisting">void	xmlInitializePredefinedEntities	(void)<br>
508*7c568831SAndroid Build Coastguard Worker</pre>
509*7c568831SAndroid Build Coastguard Worker<p>Set up the predefined entities. Deprecated call</p>
510*7c568831SAndroid Build Coastguard Worker</div>
511*7c568831SAndroid Build Coastguard Worker<hr>
512*7c568831SAndroid Build Coastguard Worker<div class="refsect2" lang="en">
513*7c568831SAndroid Build Coastguard Worker<h3>
514*7c568831SAndroid Build Coastguard Worker<a name="xmlNewEntity"></a>xmlNewEntity ()</h3>
515*7c568831SAndroid Build Coastguard Worker<pre class="programlisting"><a href="libxml2-tree.html#xmlEntityPtr">xmlEntityPtr</a>	xmlNewEntity		(<a href="libxml2-tree.html#xmlDocPtr">xmlDocPtr</a> doc, <br>					 const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name, <br>					 int type, <br>					 const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * ExternalID, <br>					 const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * SystemID, <br>					 const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * content)<br>
516*7c568831SAndroid Build Coastguard Worker</pre>
517*7c568831SAndroid Build Coastguard Worker<p>Create a new entity, this differs from xmlAddDocEntity() that if the document is NULL or has no internal subset defined, then an unlinked entity structure will be returned, it is then the responsibility of the caller to link it to the document later or free it when not needed anymore.</p>
518*7c568831SAndroid Build Coastguard Worker<div class="variablelist"><table border="0">
519*7c568831SAndroid Build Coastguard Worker<col align="left">
520*7c568831SAndroid Build Coastguard Worker<tbody>
521*7c568831SAndroid Build Coastguard Worker<tr>
522*7c568831SAndroid Build Coastguard Worker<td><span class="term"><i><tt>doc</tt></i>:</span></td>
523*7c568831SAndroid Build Coastguard Worker<td>the document</td>
524*7c568831SAndroid Build Coastguard Worker</tr>
525*7c568831SAndroid Build Coastguard Worker<tr>
526*7c568831SAndroid Build Coastguard Worker<td><span class="term"><i><tt>name</tt></i>:</span></td>
527*7c568831SAndroid Build Coastguard Worker<td>the entity name</td>
528*7c568831SAndroid Build Coastguard Worker</tr>
529*7c568831SAndroid Build Coastguard Worker<tr>
530*7c568831SAndroid Build Coastguard Worker<td><span class="term"><i><tt>type</tt></i>:</span></td>
531*7c568831SAndroid Build Coastguard Worker<td>the entity type XML_xxx_yyy_ENTITY</td>
532*7c568831SAndroid Build Coastguard Worker</tr>
533*7c568831SAndroid Build Coastguard Worker<tr>
534*7c568831SAndroid Build Coastguard Worker<td><span class="term"><i><tt>ExternalID</tt></i>:</span></td>
535*7c568831SAndroid Build Coastguard Worker<td>the entity external ID if available</td>
536*7c568831SAndroid Build Coastguard Worker</tr>
537*7c568831SAndroid Build Coastguard Worker<tr>
538*7c568831SAndroid Build Coastguard Worker<td><span class="term"><i><tt>SystemID</tt></i>:</span></td>
539*7c568831SAndroid Build Coastguard Worker<td>the entity system ID if available</td>
540*7c568831SAndroid Build Coastguard Worker</tr>
541*7c568831SAndroid Build Coastguard Worker<tr>
542*7c568831SAndroid Build Coastguard Worker<td><span class="term"><i><tt>content</tt></i>:</span></td>
543*7c568831SAndroid Build Coastguard Worker<td>the entity content</td>
544*7c568831SAndroid Build Coastguard Worker</tr>
545*7c568831SAndroid Build Coastguard Worker<tr>
546*7c568831SAndroid Build Coastguard Worker<td><span class="term"><i><tt>Returns</tt></i>:</span></td>
547*7c568831SAndroid Build Coastguard Worker<td>a pointer to the entity or NULL in case of error</td>
548*7c568831SAndroid Build Coastguard Worker</tr>
549*7c568831SAndroid Build Coastguard Worker</tbody>
550*7c568831SAndroid Build Coastguard Worker</table></div>
551*7c568831SAndroid Build Coastguard Worker</div>
552*7c568831SAndroid Build Coastguard Worker<hr>
553*7c568831SAndroid Build Coastguard Worker</div>
554*7c568831SAndroid Build Coastguard Worker</div>
555*7c568831SAndroid Build Coastguard Worker</body>
556*7c568831SAndroid Build Coastguard Worker</html>
557