1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>Class Poco::XML::ParserEngine</title>
<meta http-equiv="content-type" content="text/html; charset=utf-8"/>
<meta name="author" content="Applied Informatics Software Engineering GmbH and Contributors"/>
<meta name="publisher" content="Applied Informatics Software Engineering GmbH and Contributors"/>
<meta name="copyright" content="Copyright (c) 2009, Applied Informatics Software Engineering GmbH and Contributors"/>
<meta name="language" content="en"/>
<meta name="date" content="2009-11-24"/>
<meta name="generator" content="PocoDoc"/>
<link rel="stylesheet" href="css/styles.css" type="text/css"/>
</head>
<body bgcolor="#ffffff" leftmargin="0" topmargin="0">
<div class="header">
<h1 class="namespace"><a href="Poco.XML.html" class="namespace">Poco::XML</a></h1>
<h1 class="symbol">class ParserEngine</h1>
</div>
<div class="body">
<p>
<b>Library:</b> XML<br />
<b>Package:</b> XML<br />
<b>Header:</b> Poco/XML/ParserEngine.h</p>
<h2>Description</h2>
<div class="description">
<p>This class provides an object-oriented, stream-based, low-level interface to the <a href="Poco.XML.html" title="namespace Poco::XML">XML</a> Parser Toolkit (expat). It is strongly recommended, that you use the SAX parser classes (which are based on this class) instead of this class, since they provide a standardized, higher-level interface to the parser. </p>
</div>
<h2>Inheritance</h2>
<p><b>Direct Base Classes: </b><a href="Poco.XML.Locator.html" title="class Poco::XML::Locator">Locator</a></p>
<p><b>All Base Classes: </b><a href="Poco.XML.Locator.html" title="class Poco::XML::Locator">Locator</a></p>
<h2>Member Summary</h2>
<p><b>Member Functions: </b><a href="Poco.XML.ParserEngine.html#19625" title="Poco::XML::ParserEngine::addEncoding()">addEncoding</a>, <a href="Poco.XML.ParserEngine.html#19789" title="Poco::XML::ParserEngine::convert()">convert</a>, <a href="Poco.XML.ParserEngine.html#19669" title="Poco::XML::ParserEngine::getColumnNumber()">getColumnNumber</a>, <a href="Poco.XML.ParserEngine.html#19651" title="Poco::XML::ParserEngine::getContentHandler()">getContentHandler</a>, <a href="Poco.XML.ParserEngine.html#19645" title="Poco::XML::ParserEngine::getDTDHandler()">getDTDHandler</a>, <a href="Poco.XML.ParserEngine.html#19648" title="Poco::XML::ParserEngine::getDeclHandler()">getDeclHandler</a>, <a href="Poco.XML.ParserEngine.html#19660" title="Poco::XML::ParserEngine::getEnablePartialReads()">getEnablePartialReads</a>, <a href="Poco.XML.ParserEngine.html#19624" title="Poco::XML::ParserEngine::getEncoding()">getEncoding</a>, <a href="Poco.XML.ParserEngine.html#19642" title="Poco::XML::ParserEngine::getEntityResolver()">getEntityResolver</a>, <a href="Poco.XML.ParserEngine.html#19657" title="Poco::XML::ParserEngine::getErrorHandler()">getErrorHandler</a>, <a href="Poco.XML.ParserEngine.html#19633" title="Poco::XML::ParserEngine::getExpandInternalEntities()">getExpandInternalEntities</a>, <a href="Poco.XML.ParserEngine.html#19636" title="Poco::XML::ParserEngine::getExternalGeneralEntities()">getExternalGeneralEntities</a>, <a href="Poco.XML.ParserEngine.html#19639" title="Poco::XML::ParserEngine::getExternalParameterEntities()">getExternalParameterEntities</a>, <a href="Poco.XML.ParserEngine.html#19654" title="Poco::XML::ParserEngine::getLexicalHandler()">getLexicalHandler</a>, <a href="Poco.XML.ParserEngine.html#19668" title="Poco::XML::ParserEngine::getLineNumber()">getLineNumber</a>, <a href="Poco.XML.ParserEngine.html#19630" title="Poco::XML::ParserEngine::getNamespaceStrategy()">getNamespaceStrategy</a>, <a href="Poco.XML.ParserEngine.html#19666" title="Poco::XML::ParserEngine::getPublicId()">getPublicId</a>, <a href="Poco.XML.ParserEngine.html#19667" title="Poco::XML::ParserEngine::getSystemId()">getSystemId</a>, <a href="Poco.XML.ParserEngine.html#19707" title="Poco::XML::ParserEngine::handleCharacterData()">handleCharacterData</a>, <a href="Poco.XML.ParserEngine.html#19742" title="Poco::XML::ParserEngine::handleComment()">handleComment</a>, <a href="Poco.XML.ParserEngine.html#19715" title="Poco::XML::ParserEngine::handleDefault()">handleDefault</a>, <a href="Poco.XML.ParserEngine.html#19747" title="Poco::XML::ParserEngine::handleEndCdataSection()">handleEndCdataSection</a>, <a href="Poco.XML.ParserEngine.html#19762" title="Poco::XML::ParserEngine::handleEndDoctypeDecl()">handleEndDoctypeDecl</a>, <a href="Poco.XML.ParserEngine.html#19704" title="Poco::XML::ParserEngine::handleEndElement()">handleEndElement</a>, <a href="Poco.XML.ParserEngine.html#19753" title="Poco::XML::ParserEngine::handleEndNamespaceDecl()">handleEndNamespaceDecl</a>, <a href="Poco.XML.ParserEngine.html#19764" title="Poco::XML::ParserEngine::handleEntityDecl()">handleEntityDecl</a>, <a href="Poco.XML.ParserEngine.html#19683" title="Poco::XML::ParserEngine::handleError()">handleError</a>, <a href="Poco.XML.ParserEngine.html#19732" title="Poco::XML::ParserEngine::handleExternalEntityRef()">handleExternalEntityRef</a>, <a href="Poco.XML.ParserEngine.html#19774" title="Poco::XML::ParserEngine::handleExternalParsedEntityDecl()">handleExternalParsedEntityDecl</a>, <a href="Poco.XML.ParserEngine.html#19780" title="Poco::XML::ParserEngine::handleInternalParsedEntityDecl()">handleInternalParsedEntityDecl</a>, <a href="Poco.XML.ParserEngine.html#19726" title="Poco::XML::ParserEngine::handleNotationDecl()">handleNotationDecl</a>, <a href="Poco.XML.ParserEngine.html#19711" title="Poco::XML::ParserEngine::handleProcessingInstruction()">handleProcessingInstruction</a>, <a href="Poco.XML.ParserEngine.html#19785" title="Poco::XML::ParserEngine::handleSkippedEntity()">handleSkippedEntity</a>, <a href="Poco.XML.ParserEngine.html#19745" title="Poco::XML::ParserEngine::handleStartCdataSection()">handleStartCdataSection</a>, <a href="Poco.XML.ParserEngine.html#19756" title="Poco::XML::ParserEngine::handleStartDoctypeDecl()">handleStartDoctypeDecl</a>, <a href="Poco.XML.ParserEngine.html#19700" title="Poco::XML::ParserEngine::handleStartElement()">handleStartElement</a>, <a href="Poco.XML.ParserEngine.html#19749" title="Poco::XML::ParserEngine::handleStartNamespaceDecl()">handleStartNamespaceDecl</a>, <a href="Poco.XML.ParserEngine.html#19738" title="Poco::XML::ParserEngine::handleUnknownEncoding()">handleUnknownEncoding</a>, <a href="Poco.XML.ParserEngine.html#19719" title="Poco::XML::ParserEngine::handleUnparsedEntityDecl()">handleUnparsedEntityDecl</a>, <a href="Poco.XML.ParserEngine.html#19670" title="Poco::XML::ParserEngine::init()">init</a>, <a href="Poco.XML.ParserEngine.html#19699" title="Poco::XML::ParserEngine::locator()">locator</a>, <a href="Poco.XML.ParserEngine.html#19661" title="Poco::XML::ParserEngine::parse()">parse</a>, <a href="Poco.XML.ParserEngine.html#19671" title="Poco::XML::ParserEngine::parseByteInputStream()">parseByteInputStream</a>, <a href="Poco.XML.ParserEngine.html#19673" title="Poco::XML::ParserEngine::parseCharInputStream()">parseCharInputStream</a>, <a href="Poco.XML.ParserEngine.html#19685" title="Poco::XML::ParserEngine::parseExternal()">parseExternal</a>, <a href="Poco.XML.ParserEngine.html#19688" title="Poco::XML::ParserEngine::parseExternalByteInputStream()">parseExternalByteInputStream</a>, <a href="Poco.XML.ParserEngine.html#19691" title="Poco::XML::ParserEngine::parseExternalCharInputStream()">parseExternalCharInputStream</a>, <a href="Poco.XML.ParserEngine.html#19697" title="Poco::XML::ParserEngine::popContext()">popContext</a>, <a href="Poco.XML.ParserEngine.html#19694" title="Poco::XML::ParserEngine::pushContext()">pushContext</a>, <a href="Poco.XML.ParserEngine.html#19675" title="Poco::XML::ParserEngine::readBytes()">readBytes</a>, <a href="Poco.XML.ParserEngine.html#19679" title="Poco::XML::ParserEngine::readChars()">readChars</a>, <a href="Poco.XML.ParserEngine.html#19698" title="Poco::XML::ParserEngine::resetContext()">resetContext</a>, <a href="Poco.XML.ParserEngine.html#19649" title="Poco::XML::ParserEngine::setContentHandler()">setContentHandler</a>, <a href="Poco.XML.ParserEngine.html#19643" title="Poco::XML::ParserEngine::setDTDHandler()">setDTDHandler</a>, <a href="Poco.XML.ParserEngine.html#19646" title="Poco::XML::ParserEngine::setDeclHandler()">setDeclHandler</a>, <a href="Poco.XML.ParserEngine.html#19658" title="Poco::XML::ParserEngine::setEnablePartialReads()">setEnablePartialReads</a>, <a href="Poco.XML.ParserEngine.html#19622" title="Poco::XML::ParserEngine::setEncoding()">setEncoding</a>, <a href="Poco.XML.ParserEngine.html#19640" title="Poco::XML::ParserEngine::setEntityResolver()">setEntityResolver</a>, <a href="Poco.XML.ParserEngine.html#19655" title="Poco::XML::ParserEngine::setErrorHandler()">setErrorHandler</a>, <a href="Poco.XML.ParserEngine.html#19631" title="Poco::XML::ParserEngine::setExpandInternalEntities()">setExpandInternalEntities</a>, <a href="Poco.XML.ParserEngine.html#19634" title="Poco::XML::ParserEngine::setExternalGeneralEntities()">setExternalGeneralEntities</a>, <a href="Poco.XML.ParserEngine.html#19637" title="Poco::XML::ParserEngine::setExternalParameterEntities()">setExternalParameterEntities</a>, <a href="Poco.XML.ParserEngine.html#19652" title="Poco::XML::ParserEngine::setLexicalHandler()">setLexicalHandler</a>, <a href="Poco.XML.ParserEngine.html#19628" title="Poco::XML::ParserEngine::setNamespaceStrategy()">setNamespaceStrategy</a></p>
<p><b>Inherited Functions: </b><a href="Poco.XML.Locator.html#19046" title="Poco::XML::Locator::getColumnNumber()">getColumnNumber</a>, <a href="Poco.XML.Locator.html#19045" title="Poco::XML::Locator::getLineNumber()">getLineNumber</a>, <a href="Poco.XML.Locator.html#19043" title="Poco::XML::Locator::getPublicId()">getPublicId</a>, <a href="Poco.XML.Locator.html#19044" title="Poco::XML::Locator::getSystemId()">getSystemId</a></p>
<h2>Constructors</h2>
<h3><a name="19618">ParserEngine</a></h3>
<p class="decl"><a href="Poco.XML.ParserEngine.html" title="class Poco::XML::ParserEngine">ParserEngine</a>();</p>
<div class="description">
<p>Creates the parser engine. </p>
</div>
<h3><a name="19619">ParserEngine</a></h3>
<p class="decl"><a href="Poco.XML.ParserEngine.html" title="class Poco::XML::ParserEngine">ParserEngine</a>(<br /> const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> & encoding<br />);</p>
<div class="description">
<p>Creates the parser engine and passes the encoding to the underlying parser. </p>
</div>
<h2>Destructor</h2>
<h3><a name="19621">~ParserEngine</a> <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">~<a href="Poco.XML.ParserEngine.html" title="class Poco::XML::ParserEngine">ParserEngine</a>();</p>
<div class="description">
<p>Destroys the parser. </p>
</div>
<h2>Member Functions</h2>
<h3><a name="19625">addEncoding</a></h3>
<p class="decl">void addEncoding(<br /> const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> & name,<br /> <a href="Poco.TextEncoding.html" title="class Poco::TextEncoding">Poco::TextEncoding</a> * pEncoding<br />);</p>
<div class="description">
<p>Adds an encoding to the parser. </p>
</div>
<h3><a name="19669">getColumnNumber</a> <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">int getColumnNumber() const;</p>
<div class="description">
<p>Return the column number where the current document event ends. </p>
</div>
<div class="description"><p><b>See also:</b> <a href="Poco.XML.Locator.html#19046" title="Poco::XML::Locator::getColumnNumber()">Poco::XML::Locator::getColumnNumber()</a></p></div>
<h3><a name="19651">getContentHandler</a> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl"><a href="Poco.XML.ContentHandler.html" title="class Poco::XML::ContentHandler">ContentHandler</a> * getContentHandler() const;</p>
<div class="description">
<p>Return the current content handler. </p>
</div>
<h3><a name="19645">getDTDHandler</a> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl"><a href="Poco.XML.DTDHandler.html" title="class Poco::XML::DTDHandler">DTDHandler</a> * getDTDHandler() const;</p>
<div class="description">
<p>Return the current DTD handler. </p>
</div>
<h3><a name="19648">getDeclHandler</a> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl"><a href="Poco.XML.DeclHandler.html" title="class Poco::XML::DeclHandler">DeclHandler</a> * getDeclHandler() const;</p>
<div class="description">
<p>Return the current DTD declarations handler. </p>
</div>
<h3><a name="19660">getEnablePartialReads</a> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">bool getEnablePartialReads() const;</p>
<div class="description">
<p>Returns true if partial reads are enabled (see <a href="Poco.XML.ParserEngine.html#19658" title="Poco::XML::ParserEngine::setEnablePartialReads()">setEnablePartialReads</a>()), false otherwise. </p>
</div>
<h3><a name="19624">getEncoding</a> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> & getEncoding() const;</p>
<div class="description">
<p>Returns the encoding used by expat. </p>
</div>
<h3><a name="19642">getEntityResolver</a> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl"><a href="Poco.XML.EntityResolver.html" title="class Poco::XML::EntityResolver">EntityResolver</a> * getEntityResolver() const;</p>
<div class="description">
<p>Return the current entity resolver. </p>
</div>
<h3><a name="19657">getErrorHandler</a> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl"><a href="Poco.XML.ErrorHandler.html" title="class Poco::XML::ErrorHandler">ErrorHandler</a> * getErrorHandler() const;</p>
<div class="description">
<p>Return the current error handler. </p>
</div>
<h3><a name="19633">getExpandInternalEntities</a> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">bool getExpandInternalEntities() const;</p>
<div class="description">
<p>Returns true if internal entities will be expanded automatically, which is the default. </p>
</div>
<h3><a name="19636">getExternalGeneralEntities</a> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">bool getExternalGeneralEntities() const;</p>
<div class="description">
<p>Returns true if external general entities will be processed; false otherwise. </p>
</div>
<h3><a name="19639">getExternalParameterEntities</a> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">bool getExternalParameterEntities() const;</p>
<div class="description">
<p>Returns true if external parameter entities will be processed; false otherwise. </p>
</div>
<h3><a name="19654">getLexicalHandler</a> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl"><a href="Poco.XML.LexicalHandler.html" title="class Poco::XML::LexicalHandler">LexicalHandler</a> * getLexicalHandler() const;</p>
<div class="description">
<p>Return the current lexical handler. </p>
</div>
<h3><a name="19668">getLineNumber</a> <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">int getLineNumber() const;</p>
<div class="description">
<p>Return the line number where the current document event ends. </p>
</div>
<div class="description"><p><b>See also:</b> <a href="Poco.XML.Locator.html#19045" title="Poco::XML::Locator::getLineNumber()">Poco::XML::Locator::getLineNumber()</a></p></div>
<h3><a name="19630">getNamespaceStrategy</a> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl"><a href="Poco.XML.NamespaceStrategy.html" title="class Poco::XML::NamespaceStrategy">NamespaceStrategy</a> * getNamespaceStrategy() const;</p>
<div class="description">
<p>Returns the <a href="Poco.XML.NamespaceStrategy.html" title="class Poco::XML::NamespaceStrategy">NamespaceStrategy</a> currently in use. </p>
</div>
<h3><a name="19666">getPublicId</a> <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl"><a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> getPublicId() const;</p>
<div class="description">
<p>Return the public identifier for the current document event. </p>
</div>
<div class="description"><p><b>See also:</b> <a href="Poco.XML.Locator.html#19043" title="Poco::XML::Locator::getPublicId()">Poco::XML::Locator::getPublicId()</a></p></div>
<h3><a name="19667">getSystemId</a> <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl"><a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> getSystemId() const;</p>
<div class="description">
<p>Return the system identifier for the current document event. </p>
</div>
<div class="description"><p><b>See also:</b> <a href="Poco.XML.Locator.html#19044" title="Poco::XML::Locator::getSystemId()">Poco::XML::Locator::getSystemId()</a></p></div>
<h3><a name="19661">parse</a></h3>
<p class="decl">void parse(<br /> <a href="Poco.XML.InputSource.html" title="class Poco::XML::InputSource">InputSource</a> * pInputSource<br />);</p>
<div class="description">
<p>Parse an <a href="Poco.XML.html" title="namespace Poco::XML">XML</a> document from the given <a href="Poco.XML.InputSource.html" title="class Poco::XML::InputSource">InputSource</a>. </p>
</div>
<h3><a name="19663">parse</a></h3>
<p class="decl">void parse(<br /> const char * pBuffer,<br /> std::size_t size<br />);</p>
<div class="description">
<p>Parses an <a href="Poco.XML.html" title="namespace Poco::XML">XML</a> document from the given buffer. </p>
</div>
<h3><a name="19649">setContentHandler</a></h3>
<p class="decl">void setContentHandler(<br /> <a href="Poco.XML.ContentHandler.html" title="class Poco::XML::ContentHandler">ContentHandler</a> * pContentHandler<br />);</p>
<div class="description">
<p>Allow an application to register a content event handler. </p>
</div>
<h3><a name="19643">setDTDHandler</a></h3>
<p class="decl">void setDTDHandler(<br /> <a href="Poco.XML.DTDHandler.html" title="class Poco::XML::DTDHandler">DTDHandler</a> * pDTDHandler<br />);</p>
<div class="description">
<p>Allow an application to register a DTD event handler. </p>
</div>
<h3><a name="19646">setDeclHandler</a></h3>
<p class="decl">void setDeclHandler(<br /> <a href="Poco.XML.DeclHandler.html" title="class Poco::XML::DeclHandler">DeclHandler</a> * pDeclHandler<br />);</p>
<div class="description">
<p>Allow an application to register a DTD declarations event handler. </p>
</div>
<h3><a name="19658">setEnablePartialReads</a></h3>
<p class="decl">void setEnablePartialReads(<br /> bool flag = true<br />);</p>
<div class="description">
<p>Enable or disable partial reads from the input source. </p>
<p>This is useful for parsing <a href="Poco.XML.html" title="namespace Poco::XML">XML</a> from a socket stream for a protocol like XMPP, where basically single elements are read one at a time from the input source's stream, and following elements depend upon responses sent back to the peer. </p>
<p>Normally, the parser always reads blocks of <a href="Poco.XML.ParserEngine.html#19811" title="Poco::XML::ParserEngine::PARSE_BUFFER_SIZE">PARSE_BUFFER_SIZE</a> at a time, and blocks until a complete block has been read (or the end of the stream has been reached). This allows for efficient parsing of "complete" <a href="Poco.XML.html" title="namespace Poco::XML">XML</a> documents, but fails in a case such as XMPP, where only <a href="Poco.XML.html" title="namespace Poco::XML">XML</a> fragments are sent at a time. </p>
</div>
<h3><a name="19622">setEncoding</a></h3>
<p class="decl">void setEncoding(<br /> const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> & encoding<br />);</p>
<div class="description">
<p>Sets the encoding used by expat. The encoding must be set before parsing begins, otherwise it will be ignored. </p>
</div>
<h3><a name="19640">setEntityResolver</a></h3>
<p class="decl">void setEntityResolver(<br /> <a href="Poco.XML.EntityResolver.html" title="class Poco::XML::EntityResolver">EntityResolver</a> * pResolver<br />);</p>
<div class="description">
<p>Allow an application to register an entity resolver. </p>
</div>
<h3><a name="19655">setErrorHandler</a></h3>
<p class="decl">void setErrorHandler(<br /> <a href="Poco.XML.ErrorHandler.html" title="class Poco::XML::ErrorHandler">ErrorHandler</a> * pErrorHandler<br />);</p>
<div class="description">
<p>Allow an application to register an error event handler. </p>
</div>
<h3><a name="19631">setExpandInternalEntities</a></h3>
<p class="decl">void setExpandInternalEntities(<br /> bool flag = true<br />);</p>
<div class="description">
<p>Enables/disables expansion of internal entities (enabled by default). If entity expansion is disabled, internal entities are reported via the default handler. Must be set before parsing begins, otherwise it will be ignored. </p>
</div>
<h3><a name="19634">setExternalGeneralEntities</a></h3>
<p class="decl">void setExternalGeneralEntities(<br /> bool flag = true<br />);</p>
<div class="description">
<p>Enable or disable processing of external general entities. </p>
</div>
<h3><a name="19637">setExternalParameterEntities</a></h3>
<p class="decl">void setExternalParameterEntities(<br /> bool flag = true<br />);</p>
<div class="description">
<p>Enable or disable processing of external parameter entities. </p>
</div>
<h3><a name="19652">setLexicalHandler</a></h3>
<p class="decl">void setLexicalHandler(<br /> <a href="Poco.XML.LexicalHandler.html" title="class Poco::XML::LexicalHandler">LexicalHandler</a> * pLexicalHandler<br />);</p>
<div class="description">
<p>Allow an application to register a lexical event handler. </p>
</div>
<h3><a name="19628">setNamespaceStrategy</a></h3>
<p class="decl">void setNamespaceStrategy(<br /> <a href="Poco.XML.NamespaceStrategy.html" title="class Poco::XML::NamespaceStrategy">NamespaceStrategy</a> * pStrategy<br />);</p>
<div class="description">
<p>Sets the <a href="Poco.XML.NamespaceStrategy.html" title="class Poco::XML::NamespaceStrategy">NamespaceStrategy</a> used by the parser. The parser takes ownership of the strategy object and deletes it when it's no longer needed. The default is <a href="Poco.XML.NoNamespacesStrategy.html" title="class Poco::XML::NoNamespacesStrategy">NoNamespacesStrategy</a>. </p>
</div>
<h3><a name="19789">convert</a> <img src="images/protected.gif" alt="protected" title="protected" style="vertical-align:baseline;" border="0" /> <img src="images/static.gif" alt="static" title="static" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">static int convert(<br /> void * data,<br /> const char * s<br />);</p>
<div class="description">
<p></p>
</div>
<h3><a name="19707">handleCharacterData</a> <img src="images/protected.gif" alt="protected" title="protected" style="vertical-align:baseline;" border="0" /> <img src="images/static.gif" alt="static" title="static" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">static void handleCharacterData(<br /> void * userData,<br /> const XML_Char * s,<br /> int len<br />);</p>
<div class="description">
<p></p>
</div>
<h3><a name="19742">handleComment</a> <img src="images/protected.gif" alt="protected" title="protected" style="vertical-align:baseline;" border="0" /> <img src="images/static.gif" alt="static" title="static" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">static void handleComment(<br /> void * userData,<br /> const XML_Char * data<br />);</p>
<div class="description">
<p></p>
</div>
<h3><a name="19715">handleDefault</a> <img src="images/protected.gif" alt="protected" title="protected" style="vertical-align:baseline;" border="0" /> <img src="images/static.gif" alt="static" title="static" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">static void handleDefault(<br /> void * userData,<br /> const XML_Char * s,<br /> int len<br />);</p>
<div class="description">
<p></p>
</div>
<h3><a name="19747">handleEndCdataSection</a> <img src="images/protected.gif" alt="protected" title="protected" style="vertical-align:baseline;" border="0" /> <img src="images/static.gif" alt="static" title="static" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">static void handleEndCdataSection(<br /> void * userData<br />);</p>
<div class="description">
<p></p>
</div>
<h3><a name="19762">handleEndDoctypeDecl</a> <img src="images/protected.gif" alt="protected" title="protected" style="vertical-align:baseline;" border="0" /> <img src="images/static.gif" alt="static" title="static" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">static void handleEndDoctypeDecl(<br /> void * userData<br />);</p>
<div class="description">
<p></p>
</div>
<h3><a name="19704">handleEndElement</a> <img src="images/protected.gif" alt="protected" title="protected" style="vertical-align:baseline;" border="0" /> <img src="images/static.gif" alt="static" title="static" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">static void handleEndElement(<br /> void * userData,<br /> const XML_Char * name<br />);</p>
<div class="description">
<p></p>
</div>
<h3><a name="19753">handleEndNamespaceDecl</a> <img src="images/protected.gif" alt="protected" title="protected" style="vertical-align:baseline;" border="0" /> <img src="images/static.gif" alt="static" title="static" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">static void handleEndNamespaceDecl(<br /> void * userData,<br /> const XML_Char * prefix<br />);</p>
<div class="description">
<p></p>
</div>
<h3><a name="19764">handleEntityDecl</a> <img src="images/protected.gif" alt="protected" title="protected" style="vertical-align:baseline;" border="0" /> <img src="images/static.gif" alt="static" title="static" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">static void handleEntityDecl(<br /> void * userData,<br /> const XML_Char * entityName,<br /> int isParamEntity,<br /> const XML_Char * value,<br /> int valueLength,<br /> const XML_Char * base,<br /> const XML_Char * systemId,<br /> const XML_Char * publicId,<br /> const XML_Char * notationName<br />);</p>
<div class="description">
<p></p>
</div>
<h3><a name="19683">handleError</a> <img src="images/protected.gif" alt="protected" title="protected" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">void handleError(<br /> int errorNo<br />);</p>
<div class="description">
<p>Throws an <a href="Poco.XML.XMLException.html" title="class Poco::XML::XMLException">XMLException</a> with a message corresponding to the given Expat error code. </p>
</div>
<h3><a name="19732">handleExternalEntityRef</a> <img src="images/protected.gif" alt="protected" title="protected" style="vertical-align:baseline;" border="0" /> <img src="images/static.gif" alt="static" title="static" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">static int handleExternalEntityRef(<br /> XML_Parser parser,<br /> const XML_Char * openEntityNames,<br /> const XML_Char * base,<br /> const XML_Char * systemId,<br /> const XML_Char * publicId<br />);</p>
<div class="description">
<p></p>
</div>
<h3><a name="19774">handleExternalParsedEntityDecl</a> <img src="images/protected.gif" alt="protected" title="protected" style="vertical-align:baseline;" border="0" /> <img src="images/static.gif" alt="static" title="static" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">static void handleExternalParsedEntityDecl(<br /> void * userData,<br /> const XML_Char * entityName,<br /> const XML_Char * base,<br /> const XML_Char * systemId,<br /> const XML_Char * publicId<br />);</p>
<div class="description">
<p></p>
</div>
<h3><a name="19780">handleInternalParsedEntityDecl</a> <img src="images/protected.gif" alt="protected" title="protected" style="vertical-align:baseline;" border="0" /> <img src="images/static.gif" alt="static" title="static" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">static void handleInternalParsedEntityDecl(<br /> void * userData,<br /> const XML_Char * entityName,<br /> const XML_Char * replacementText,<br /> int replacementTextLength<br />);</p>
<div class="description">
<p></p>
</div>
<h3><a name="19726">handleNotationDecl</a> <img src="images/protected.gif" alt="protected" title="protected" style="vertical-align:baseline;" border="0" /> <img src="images/static.gif" alt="static" title="static" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">static void handleNotationDecl(<br /> void * userData,<br /> const XML_Char * notationName,<br /> const XML_Char * base,<br /> const XML_Char * systemId,<br /> const XML_Char * publicId<br />);</p>
<div class="description">
<p></p>
</div>
<h3><a name="19711">handleProcessingInstruction</a> <img src="images/protected.gif" alt="protected" title="protected" style="vertical-align:baseline;" border="0" /> <img src="images/static.gif" alt="static" title="static" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">static void handleProcessingInstruction(<br /> void * userData,<br /> const XML_Char * target,<br /> const XML_Char * data<br />);</p>
<div class="description">
<p></p>
</div>
<h3><a name="19785">handleSkippedEntity</a> <img src="images/protected.gif" alt="protected" title="protected" style="vertical-align:baseline;" border="0" /> <img src="images/static.gif" alt="static" title="static" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">static void handleSkippedEntity(<br /> void * userData,<br /> const XML_Char * entityName,<br /> int isParameterEntity<br />);</p>
<div class="description">
<p></p>
</div>
<h3><a name="19745">handleStartCdataSection</a> <img src="images/protected.gif" alt="protected" title="protected" style="vertical-align:baseline;" border="0" /> <img src="images/static.gif" alt="static" title="static" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">static void handleStartCdataSection(<br /> void * userData<br />);</p>
<div class="description">
<p></p>
</div>
<h3><a name="19756">handleStartDoctypeDecl</a> <img src="images/protected.gif" alt="protected" title="protected" style="vertical-align:baseline;" border="0" /> <img src="images/static.gif" alt="static" title="static" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">static void handleStartDoctypeDecl(<br /> void * userData,<br /> const XML_Char * doctypeName,<br /> const XML_Char * systemId,<br /> const XML_Char * publicId,<br /> int hasInternalSubset<br />);</p>
<div class="description">
<p></p>
</div>
<h3><a name="19700">handleStartElement</a> <img src="images/protected.gif" alt="protected" title="protected" style="vertical-align:baseline;" border="0" /> <img src="images/static.gif" alt="static" title="static" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">static void handleStartElement(<br /> void * userData,<br /> const XML_Char * name,<br /> const XML_Char * * atts<br />);</p>
<div class="description">
<p></p>
</div>
<h3><a name="19749">handleStartNamespaceDecl</a> <img src="images/protected.gif" alt="protected" title="protected" style="vertical-align:baseline;" border="0" /> <img src="images/static.gif" alt="static" title="static" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">static void handleStartNamespaceDecl(<br /> void * userData,<br /> const XML_Char * prefix,<br /> const XML_Char * uri<br />);</p>
<div class="description">
<p></p>
</div>
<h3><a name="19738">handleUnknownEncoding</a> <img src="images/protected.gif" alt="protected" title="protected" style="vertical-align:baseline;" border="0" /> <img src="images/static.gif" alt="static" title="static" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">static int handleUnknownEncoding(<br /> void * encodingHandlerData,<br /> const XML_Char * name,<br /> XML_Encoding * info<br />);</p>
<div class="description">
<p></p>
</div>
<h3><a name="19719">handleUnparsedEntityDecl</a> <img src="images/protected.gif" alt="protected" title="protected" style="vertical-align:baseline;" border="0" /> <img src="images/static.gif" alt="static" title="static" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">static void handleUnparsedEntityDecl(<br /> void * userData,<br /> const XML_Char * entityName,<br /> const XML_Char * base,<br /> const XML_Char * systemId,<br /> const XML_Char * publicId,<br /> const XML_Char * notationName<br />);</p>
<div class="description">
<p></p>
</div>
<h3><a name="19670">init</a> <img src="images/protected.gif" alt="protected" title="protected" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">void init();</p>
<div class="description">
<p>initializes expat </p>
</div>
<h3><a name="19699">locator</a> <img src="images/protected.gif" alt="protected" title="protected" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">const <a href="Poco.XML.Locator.html" title="class Poco::XML::Locator">Locator</a> & locator() const;</p>
<div class="description">
<p>Returns a locator denoting the current parse location. </p>
</div>
<h3><a name="19671">parseByteInputStream</a> <img src="images/protected.gif" alt="protected" title="protected" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">void parseByteInputStream(<br /> <a href="Poco.XML.html#19836" title="Poco::XML::XMLByteInputStream">XMLByteInputStream</a> & istr<br />);</p>
<div class="description">
<p>Parses an entity from the given stream. </p>
</div>
<h3><a name="19673">parseCharInputStream</a> <img src="images/protected.gif" alt="protected" title="protected" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">void parseCharInputStream(<br /> <a href="Poco.XML.html#19838" title="Poco::XML::XMLCharInputStream">XMLCharInputStream</a> & istr<br />);</p>
<div class="description">
<p>Parses an entity from the given stream. </p>
</div>
<h3><a name="19685">parseExternal</a> <img src="images/protected.gif" alt="protected" title="protected" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">void parseExternal(<br /> XML_Parser extParser,<br /> <a href="Poco.XML.InputSource.html" title="class Poco::XML::InputSource">InputSource</a> * pInputSource<br />);</p>
<div class="description">
<p>Parse an <a href="Poco.XML.html" title="namespace Poco::XML">XML</a> document from the given <a href="Poco.XML.InputSource.html" title="class Poco::XML::InputSource">InputSource</a>. </p>
</div>
<h3><a name="19688">parseExternalByteInputStream</a> <img src="images/protected.gif" alt="protected" title="protected" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">void parseExternalByteInputStream(<br /> XML_Parser extParser,<br /> <a href="Poco.XML.html#19836" title="Poco::XML::XMLByteInputStream">XMLByteInputStream</a> & istr<br />);</p>
<div class="description">
<p>Parses an external entity from the given stream, with a separate parser. </p>
</div>
<h3><a name="19691">parseExternalCharInputStream</a> <img src="images/protected.gif" alt="protected" title="protected" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">void parseExternalCharInputStream(<br /> XML_Parser extParser,<br /> <a href="Poco.XML.html#19838" title="Poco::XML::XMLCharInputStream">XMLCharInputStream</a> & istr<br />);</p>
<div class="description">
<p>Parses an external entity from the given stream, with a separate parser. </p>
</div>
<h3><a name="19697">popContext</a> <img src="images/protected.gif" alt="protected" title="protected" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">void popContext();</p>
<div class="description">
<p>Pops the top-most entry from the context stack. </p>
</div>
<h3><a name="19694">pushContext</a> <img src="images/protected.gif" alt="protected" title="protected" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">void pushContext(<br /> XML_Parser parser,<br /> <a href="Poco.XML.InputSource.html" title="class Poco::XML::InputSource">InputSource</a> * pInputSource<br />);</p>
<div class="description">
<p>Pushes a new entry to the context stack. </p>
</div>
<h3><a name="19675">readBytes</a> <img src="images/protected.gif" alt="protected" title="protected" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">std::streamsize readBytes(<br /> <a href="Poco.XML.html#19836" title="Poco::XML::XMLByteInputStream">XMLByteInputStream</a> & istr,<br /> char * pBuffer,<br /> std::streamsize bufferSize<br />);</p>
<div class="description">
<p>Reads at most bufferSize bytes from the given stream into the given buffer. </p>
</div>
<h3><a name="19679">readChars</a> <img src="images/protected.gif" alt="protected" title="protected" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">std::streamsize readChars(<br /> <a href="Poco.XML.html#19838" title="Poco::XML::XMLCharInputStream">XMLCharInputStream</a> & istr,<br /> <a href="Poco.XML.html#19840" title="Poco::XML::XMLChar">XMLChar</a> * pBuffer,<br /> std::streamsize bufferSize<br />);</p>
<div class="description">
<p>Reads at most bufferSize chars from the given stream into the given buffer. </p>
</div>
<h3><a name="19698">resetContext</a> <img src="images/protected.gif" alt="protected" title="protected" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">void resetContext();</p>
<div class="description">
<p>Resets and clears the context stack. </p>
</div>
<p class="footer">POCO C++ Libraries 1.3.6-all<br />
Copyright © 2009, <a href="http://pocoproject.org/" target="_blank">Applied Informatics Software Engineering GmbH and Contributors</a></p>
</div>
</body>
</html>
|
