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
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>Xerces-C++: DOMXPathResult Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.6 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li class="current"><a href="classes.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="classes.html"><span>Alphabetical List</span></a></li>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>DOMXPathResult Class Reference</h1><!-- doxytag: class="DOMXPathResult" -->The <code><a class="el" href="classDOMXPathResult.html" title="The DOMXPathResult interface represents the result of the evaluation of an XPath...">DOMXPathResult</a></code> interface represents the result of the evaluation of an XPath 1.0 or XPath 2.0 expression within the context of a particular node.
<a href="#_details">More...</a>
<p>
<p>
<a href="classDOMXPathResult-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Types</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader">Public Constants</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="classDOMXPathResult.html#b718aec450c5438e0cc3a6920044a0c1">ResultType</a> { <br>
<a class="el" href="classDOMXPathResult.html#b718aec450c5438e0cc3a6920044a0c1b6800b7cef4e81a65ca48732dd8fd05b">ANY_TYPE</a> = 0,
<a class="el" href="classDOMXPathResult.html#b718aec450c5438e0cc3a6920044a0c1ea34a8448e783d65ddd9519195cb072d">NUMBER_TYPE</a> = 1,
<a class="el" href="classDOMXPathResult.html#b718aec450c5438e0cc3a6920044a0c146318bb5e72271bc9bf5c08b9012fa31">STRING_TYPE</a> = 2,
<a class="el" href="classDOMXPathResult.html#b718aec450c5438e0cc3a6920044a0c1b783d233cc89a2850f4e13ca637d4994">BOOLEAN_TYPE</a> = 3,
<br>
<a class="el" href="classDOMXPathResult.html#b718aec450c5438e0cc3a6920044a0c16461a931354777353b499091cfc14d27">UNORDERED_NODE_ITERATOR_TYPE</a> = 4,
<a class="el" href="classDOMXPathResult.html#b718aec450c5438e0cc3a6920044a0c18e8ed330af65222a55d3ad156a7d11df">ORDERED_NODE_ITERATOR_TYPE</a> = 5,
<a class="el" href="classDOMXPathResult.html#b718aec450c5438e0cc3a6920044a0c1e0a1108c8b5cd49097fc57e513c58d21">UNORDERED_NODE_SNAPSHOT_TYPE</a> = 6,
<a class="el" href="classDOMXPathResult.html#b718aec450c5438e0cc3a6920044a0c1754c1eda41b3c5b147089cc549490d8a">ORDERED_NODE_SNAPSHOT_TYPE</a> = 7,
<br>
<a class="el" href="classDOMXPathResult.html#b718aec450c5438e0cc3a6920044a0c1f86aed2645a86b9c424519d1c12518f9">ANY_UNORDERED_NODE_TYPE</a> = 8,
<a class="el" href="classDOMXPathResult.html#b718aec450c5438e0cc3a6920044a0c1154547853ad0e89be9ea5b32f7201d6c">FIRST_ORDERED_NODE_TYPE</a> = 9,
<a class="el" href="classDOMXPathResult.html#b718aec450c5438e0cc3a6920044a0c129c33fd9a779203a89b85be9ca78444b">FIRST_RESULT_TYPE</a> = 100,
<a class="el" href="classDOMXPathResult.html#b718aec450c5438e0cc3a6920044a0c13dd3d541f3b3b02a5134310168a0f1d1">ITERATOR_RESULT_TYPE</a> = 101,
<br>
<a class="el" href="classDOMXPathResult.html#b718aec450c5438e0cc3a6920044a0c1f73de8e5229be25c88b5081ebe555c7c">SNAPSHOT_RESULT_TYPE</a> = 102
<br>
}</td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader">Destructor</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classDOMXPathResult.html#e6d02311052ec70a50347e101f7f2d56">~DOMXPathResult</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#e6d02311052ec70a50347e101f7f2d56"></a><br></td></tr>
<tr><td colspan="2"><div class="groupHeader">Functions introduced in DOM Level 3</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classDOMXPathResult.html#b718aec450c5438e0cc3a6920044a0c1">ResultType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classDOMXPathResult.html#a7cdad591722dffae7a944e1fc10bbb1">getResultType</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the result type of this result. <a href="#a7cdad591722dffae7a944e1fc10bbb1"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const <a class="el" href="classDOMTypeInfo.html">DOMTypeInfo</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classDOMXPathResult.html#764ffdd6be965061ac216509cf665c90">getTypeInfo</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the DOM type info of the current result node or value (XPath 2 only). <a href="#764ffdd6be965061ac216509cf665c90"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classDOMXPathResult.html#c5179ace7876a255efcff3b3c9db3d98">isNode</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns true if the result has a current result and the value is a node (XPath 2 only). <a href="#c5179ace7876a255efcff3b3c9db3d98"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classDOMXPathResult.html#cab3ba41dfaec6c38e4c0c485bdc204b">getBooleanValue</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the boolean value of this result. <a href="#cab3ba41dfaec6c38e4c0c485bdc204b"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classDOMXPathResult.html#f15463acf8fa32b0b7d5030472176cab">getIntegerValue</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the integer value of this result (XPath 2 only). <a href="#f15463acf8fa32b0b7d5030472176cab"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual double </td><td class="memItemRight" valign="bottom"><a class="el" href="classDOMXPathResult.html#15e02a76d2751a344030603238518edf">getNumberValue</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the number value of this result. <a href="#15e02a76d2751a344030603238518edf"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const <a class="el" href="Xerces__autoconf__config_8msvc_8hpp.html#fae8f92d83170d97f757f704eca7f52a">XMLCh</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classDOMXPathResult.html#a592b89fbd30c4f2b1631488208fbb33">getStringValue</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the string value of this result. <a href="#a592b89fbd30c4f2b1631488208fbb33"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classDOMNode.html">DOMNode</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classDOMXPathResult.html#a59d61f1f1cc677d950f788fac44e6b5">getNodeValue</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the node value of this result. <a href="#a59d61f1f1cc677d950f788fac44e6b5"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classDOMXPathResult.html#963997f9fbe6eca5db1be278b72695b7">iterateNext</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Iterates and returns true if the current result is the next item from the sequence or false if there are no more items. <a href="#963997f9fbe6eca5db1be278b72695b7"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classDOMXPathResult.html#6203550451cb9d2535e08e5f6c17a50a">getInvalidIteratorState</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Signifies that the iterator has become invalid. <a href="#6203550451cb9d2535e08e5f6c17a50a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classDOMXPathResult.html#ec8aab57f5eaddc7006f2944f39462f3">snapshotItem</a> (<a class="el" href="Xerces__autoconf__config_8msvc_8hpp.html#c0f7e36996cd03eb43bcee10321f77cd">XMLSize_t</a> index)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the current result to the indexth item in the snapshot collection. <a href="#ec8aab57f5eaddc7006f2944f39462f3"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="Xerces__autoconf__config_8msvc_8hpp.html#c0f7e36996cd03eb43bcee10321f77cd">XMLSize_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classDOMXPathResult.html#229a90c6e18352c86b58e4889b559ec4">getSnapshotLength</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The number of items in the result snapshot. <a href="#229a90c6e18352c86b58e4889b559ec4"></a><br></td></tr>
<tr><td colspan="2"><div class="groupHeader">Non-standard Extension</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classDOMXPathResult.html#42d33fccfa62eb579c2c86a42c0be310">release</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Called to indicate that this <a class="el" href="classDOMXPathResult.html" title="The DOMXPathResult interface represents the result of the evaluation of an XPath...">DOMXPathResult</a> is no longer in use and that the implementation may relinquish any resources associated with it. <a href="#42d33fccfa62eb579c2c86a42c0be310"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader">Hidden constructors</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classDOMXPathResult.html#b6a4f01a6c661f6640c58c5403551ae9">DOMXPathResult</a> ()</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
The <code><a class="el" href="classDOMXPathResult.html" title="The DOMXPathResult interface represents the result of the evaluation of an XPath...">DOMXPathResult</a></code> interface represents the result of the evaluation of an XPath 1.0 or XPath 2.0 expression within the context of a particular node.
<p>
Since evaluation of an XPath expression can result in various result types, this object makes it possible to discover and manipulate the type and value of the result.<p>
Note that some function signatures were changed compared to the DOM Level 3 in order to accommodate XPath 2.0.<p>
<dl class="since" compact><dt><b>Since:</b></dt><dd>DOM Level 3 </dd></dl>
<hr><h2>Member Enumeration Documentation</h2>
<a class="anchor" name="b718aec450c5438e0cc3a6920044a0c1"></a><!-- doxytag: member="DOMXPathResult::ResultType" ref="b718aec450c5438e0cc3a6920044a0c1" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classDOMXPathResult.html#b718aec450c5438e0cc3a6920044a0c1">DOMXPathResult::ResultType</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
ANY_TYPE <br>
[XPath 1.0] This code does not represent a specific type. An evaluation of an XPath expression will never produce this type. If this type is requested, then the evaluation returns whatever type naturally results from evaluation of the expression. If the natural result is a node set when ANY_TYPE was requested, then UNORDERED_NODE_ITERATOR_TYPE is always the resulting type. Any other representation of a node set must be explicitly requested. <p>
ANY_UNORDERED_NODE_TYPE <br>
[XPath 1.0] The result is a node set as defined by XPath 1.0 and will be accessed as a single node, which may be null if the node set is empty. Document modification does not invalidate the node, but may mean that the result node no longer corresponds to the current document. This is a convenience that permits optimization since the implementation can stop once any node in the resulting set has been found. If there is more than one node in the actual result, the single node returned might not be the first in document order. <p>
BOOLEAN_TYPE <br>
[XPath 1.0] The result is a boolean as defined by XPath 1.0. Document modification does not invalidate the boolean, but may mean that reevaluation would not yield the same boolean. <p>
FIRST_ORDERED_NODE_TYPE <br>
[XPath 1.0] The result is a node set as defined by XPath 1.0 and will be accessed as a single node, which may be null if the node set is empty. Document modification does not invalidate the node, but may mean that the result node no longer corresponds to the current document. This is a convenience that permits optimization since the implementation can stop once the first node in document order of the resulting set has been found. If there are more than one node in the actual result, the single node returned will be the first in document order. <p>
NUMBER_TYPE <br>
[XPath 1.0] The result is a number as defined by XPath 1.0. Document modification does not invalidate the number, but may mean that reevaluation would not yield the same number. <p>
ORDERED_NODE_ITERATOR_TYPE <br>
[XPath 1.0] The result is a node set as defined by XPath 1.0 that will be accessed iteratively, which will produce document-ordered nodes. Document modification invalidates the iteration. <p>
ORDERED_NODE_SNAPSHOT_TYPE <br>
[XPath 1.0] The result is a node set as defined by XPath 1.0 that will be accessed as a snapshot list of nodes that will be in original document order. Document modification does not invalidate the snapshot but may mean that reevaluation would not yield the same snapshot and nodes in the snapshot may have been altered, moved, or removed from the document. <p>
STRING_TYPE <br>
[XPath 1.0] The result is a string as defined by XPath 1.0. Document modification does not invalidate the string, but may mean that the string no longer corresponds to the current document. <p>
UNORDERED_NODE_ITERATOR_TYPE <br>
[XPath 1.0] The result is a node set as defined by XPath 1.0 that will be accessed iteratively, which may not produce nodes in a particular order. Document modification invalidates the iteration. This is the default type returned if the result is a node set and ANY_TYPE is requested. <p>
UNORDERED_NODE_SNAPSHOT_TYPE <br>
[XPath 1.0] The result is a node set as defined by XPath 1.0 that will be accessed as a snapshot list of nodes that may not be in a particular order. Document modification does not invalidate the snapshot but may mean that reevaluation would not yield the same snapshot and nodes in the snapshot may have been altered, moved, or removed from the document. <p>
FIRST_RESULT_TYPE <br>
[XPath 2.0] The result is a sequence as defined by XPath 2.0 and will be accessed as a single current value or there will be no current value if the sequence is empty. Document modification does not invalidate the value, but may mean that the result no longer corresponds to the current document. This is a convenience that permits optimization since the implementation can stop once the first item in the resulting sequence has been found. If there is more than one item in the actual result, the single item returned might not be the first in document order. <p>
ITERATOR_RESULT_TYPE <br>
[XPath 2.0] The result is a sequence as defined by XPath 2.0 that will be accessed iteratively. Document modification invalidates the iteration. <p>
SNAPSHOT_RESULT_TYPE <br>
[XPath 2.0] The result is a sequence as defined by XPath 2.0 that will be accessed as a snapshot list of values. Document modification does not invalidate the snapshot but may mean that reevaluation would not yield the same snapshot and any items in the snapshot may have been altered, moved, or removed from the document. <dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" name="b718aec450c5438e0cc3a6920044a0c1b6800b7cef4e81a65ca48732dd8fd05b"></a><!-- doxytag: member="ANY_TYPE" ref="b718aec450c5438e0cc3a6920044a0c1b6800b7cef4e81a65ca48732dd8fd05b" args="" -->ANY_TYPE</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="b718aec450c5438e0cc3a6920044a0c1ea34a8448e783d65ddd9519195cb072d"></a><!-- doxytag: member="NUMBER_TYPE" ref="b718aec450c5438e0cc3a6920044a0c1ea34a8448e783d65ddd9519195cb072d" args="" -->NUMBER_TYPE</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="b718aec450c5438e0cc3a6920044a0c146318bb5e72271bc9bf5c08b9012fa31"></a><!-- doxytag: member="STRING_TYPE" ref="b718aec450c5438e0cc3a6920044a0c146318bb5e72271bc9bf5c08b9012fa31" args="" -->STRING_TYPE</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="b718aec450c5438e0cc3a6920044a0c1b783d233cc89a2850f4e13ca637d4994"></a><!-- doxytag: member="BOOLEAN_TYPE" ref="b718aec450c5438e0cc3a6920044a0c1b783d233cc89a2850f4e13ca637d4994" args="" -->BOOLEAN_TYPE</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="b718aec450c5438e0cc3a6920044a0c16461a931354777353b499091cfc14d27"></a><!-- doxytag: member="UNORDERED_NODE_ITERATOR_TYPE" ref="b718aec450c5438e0cc3a6920044a0c16461a931354777353b499091cfc14d27" args="" -->UNORDERED_NODE_ITERATOR_TYPE</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="b718aec450c5438e0cc3a6920044a0c18e8ed330af65222a55d3ad156a7d11df"></a><!-- doxytag: member="ORDERED_NODE_ITERATOR_TYPE" ref="b718aec450c5438e0cc3a6920044a0c18e8ed330af65222a55d3ad156a7d11df" args="" -->ORDERED_NODE_ITERATOR_TYPE</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="b718aec450c5438e0cc3a6920044a0c1e0a1108c8b5cd49097fc57e513c58d21"></a><!-- doxytag: member="UNORDERED_NODE_SNAPSHOT_TYPE" ref="b718aec450c5438e0cc3a6920044a0c1e0a1108c8b5cd49097fc57e513c58d21" args="" -->UNORDERED_NODE_SNAPSHOT_TYPE</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="b718aec450c5438e0cc3a6920044a0c1754c1eda41b3c5b147089cc549490d8a"></a><!-- doxytag: member="ORDERED_NODE_SNAPSHOT_TYPE" ref="b718aec450c5438e0cc3a6920044a0c1754c1eda41b3c5b147089cc549490d8a" args="" -->ORDERED_NODE_SNAPSHOT_TYPE</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="b718aec450c5438e0cc3a6920044a0c1f86aed2645a86b9c424519d1c12518f9"></a><!-- doxytag: member="ANY_UNORDERED_NODE_TYPE" ref="b718aec450c5438e0cc3a6920044a0c1f86aed2645a86b9c424519d1c12518f9" args="" -->ANY_UNORDERED_NODE_TYPE</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="b718aec450c5438e0cc3a6920044a0c1154547853ad0e89be9ea5b32f7201d6c"></a><!-- doxytag: member="FIRST_ORDERED_NODE_TYPE" ref="b718aec450c5438e0cc3a6920044a0c1154547853ad0e89be9ea5b32f7201d6c" args="" -->FIRST_ORDERED_NODE_TYPE</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="b718aec450c5438e0cc3a6920044a0c129c33fd9a779203a89b85be9ca78444b"></a><!-- doxytag: member="FIRST_RESULT_TYPE" ref="b718aec450c5438e0cc3a6920044a0c129c33fd9a779203a89b85be9ca78444b" args="" -->FIRST_RESULT_TYPE</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="b718aec450c5438e0cc3a6920044a0c13dd3d541f3b3b02a5134310168a0f1d1"></a><!-- doxytag: member="ITERATOR_RESULT_TYPE" ref="b718aec450c5438e0cc3a6920044a0c13dd3d541f3b3b02a5134310168a0f1d1" args="" -->ITERATOR_RESULT_TYPE</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="b718aec450c5438e0cc3a6920044a0c1f73de8e5229be25c88b5081ebe555c7c"></a><!-- doxytag: member="SNAPSHOT_RESULT_TYPE" ref="b718aec450c5438e0cc3a6920044a0c1f73de8e5229be25c88b5081ebe555c7c" args="" -->SNAPSHOT_RESULT_TYPE</em> </td><td>
</td></tr>
</table>
</dl>
</div>
</div><p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="b6a4f01a6c661f6640c58c5403551ae9"></a><!-- doxytag: member="DOMXPathResult::DOMXPathResult" ref="b6a4f01a6c661f6640c58c5403551ae9" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">DOMXPathResult::DOMXPathResult </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="e6d02311052ec70a50347e101f7f2d56"></a><!-- doxytag: member="DOMXPathResult::~DOMXPathResult" ref="e6d02311052ec70a50347e101f7f2d56" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual DOMXPathResult::~DOMXPathResult </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Destructor.
<p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="a7cdad591722dffae7a944e1fc10bbb1"></a><!-- doxytag: member="DOMXPathResult::getResultType" ref="a7cdad591722dffae7a944e1fc10bbb1" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classDOMXPathResult.html#b718aec450c5438e0cc3a6920044a0c1">ResultType</a> DOMXPathResult::getResultType </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns the result type of this result.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>ResultType A code representing the type of this result, as defined by the type constants. </dd></dl>
</div>
</div><p>
<a class="anchor" name="764ffdd6be965061ac216509cf665c90"></a><!-- doxytag: member="DOMXPathResult::getTypeInfo" ref="764ffdd6be965061ac216509cf665c90" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const <a class="el" href="classDOMTypeInfo.html">DOMTypeInfo</a>* DOMXPathResult::getTypeInfo </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns the DOM type info of the current result node or value (XPath 2 only).
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>typeInfo of type TypeInfo, readonly </dd></dl>
</div>
</div><p>
<a class="anchor" name="c5179ace7876a255efcff3b3c9db3d98"></a><!-- doxytag: member="DOMXPathResult::isNode" ref="c5179ace7876a255efcff3b3c9db3d98" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool DOMXPathResult::isNode </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns true if the result has a current result and the value is a node (XPath 2 only).
<p>
This function is necessary to distinguish between a string value and a node of type string as returned by the <a class="el" href="classDOMXPathResult.html#764ffdd6be965061ac216509cf665c90" title="Returns the DOM type info of the current result node or value (XPath 2 only).">getTypeInfo()</a> function. <dl class="return" compact><dt><b>Returns:</b></dt><dd>isNode of type boolean, readonly </dd></dl>
</div>
</div><p>
<a class="anchor" name="cab3ba41dfaec6c38e4c0c485bdc204b"></a><!-- doxytag: member="DOMXPathResult::getBooleanValue" ref="cab3ba41dfaec6c38e4c0c485bdc204b" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool DOMXPathResult::getBooleanValue </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns the boolean value of this result.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>booleanValue of type boolean The value of this boolean result. </dd></dl>
<dl compact><dt><b>Exceptions:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em><a class="el" href="classDOMXPathException.html">DOMXPathException</a></em> </td><td>TYPE_ERR: raised if ResultType is not BOOLEAN_TYPE (XPath 1.0) or if current result cannot be properly converted to boolean (XPath 2.0). <br>
NO_RESULT_ERROR: raised if there is no current result in the result object (XPath 2.0). </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="f15463acf8fa32b0b7d5030472176cab"></a><!-- doxytag: member="DOMXPathResult::getIntegerValue" ref="f15463acf8fa32b0b7d5030472176cab" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int DOMXPathResult::getIntegerValue </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns the integer value of this result (XPath 2 only).
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>integerValue of type int The value of this integer result. </dd></dl>
<dl compact><dt><b>Exceptions:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em><a class="el" href="classDOMXPathException.html">DOMXPathException</a></em> </td><td>TYPE_ERR: raised if current result cannot be properly converted to int (XPath 2.0). <br>
NO_RESULT_ERROR: raised if there is no current result in the result object (XPath 2.0). </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="15e02a76d2751a344030603238518edf"></a><!-- doxytag: member="DOMXPathResult::getNumberValue" ref="15e02a76d2751a344030603238518edf" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual double DOMXPathResult::getNumberValue </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns the number value of this result.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>numberValue The value of this number result. If the native double type of the DOM binding does not directly support the exact IEEE 754 result of the XPath expression, then it is up to the definition of the binding to specify how the XPath number is converted to the native binding number. </dd></dl>
<dl compact><dt><b>Exceptions:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em><a class="el" href="classDOMXPathException.html">DOMXPathException</a></em> </td><td>TYPE_ERR: raised if ResultType is not NUMBER_TYPE (XPath 1.0) or if current result cannot be properly converted to double (XPath 2.0). <br>
NO_RESULT_ERROR: raised if there is no current result in the result object (XPath 2.0). </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="a592b89fbd30c4f2b1631488208fbb33"></a><!-- doxytag: member="DOMXPathResult::getStringValue" ref="a592b89fbd30c4f2b1631488208fbb33" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const <a class="el" href="Xerces__autoconf__config_8msvc_8hpp.html#fae8f92d83170d97f757f704eca7f52a">XMLCh</a>* DOMXPathResult::getStringValue </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns the string value of this result.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>stringValue The value of this string result. </dd></dl>
<dl compact><dt><b>Exceptions:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em><a class="el" href="classDOMXPathException.html">DOMXPathException</a></em> </td><td>TYPE_ERR: raised if ResultType is not STRING_TYPE (XPath 1.0) or if current result cannot be properly converted to string (XPath 2.0). <br>
NO_RESULT_ERROR: raised if there is no current result in the result object (XPath 2.0). </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="a59d61f1f1cc677d950f788fac44e6b5"></a><!-- doxytag: member="DOMXPathResult::getNodeValue" ref="a59d61f1f1cc677d950f788fac44e6b5" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classDOMNode.html">DOMNode</a>* DOMXPathResult::getNodeValue </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns the node value of this result.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>nodeValue The value of this node result, which may be null. </dd></dl>
<dl compact><dt><b>Exceptions:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em><a class="el" href="classDOMXPathException.html">DOMXPathException</a></em> </td><td>TYPE_ERR: raised if ResultType is not ANY_UNORDERED_NODE_TYPE, FIRST_ORDERED_NODE_TYPE, UNORDERED_NODE_ITERATOR_TYPE, ORDERED_NODE_ITERATOR_TYPE, UNORDERED_NODE_SNAPSHOT_TYPE, or ORDERED_NODE_SNAPSHOT_TYPE (XPath 1.0) or if current result is not a node (XPath 2.0). <br>
NO_RESULT_ERROR: raised if there is no current result in the result object. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="963997f9fbe6eca5db1be278b72695b7"></a><!-- doxytag: member="DOMXPathResult::iterateNext" ref="963997f9fbe6eca5db1be278b72695b7" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool DOMXPathResult::iterateNext </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Iterates and returns true if the current result is the next item from the sequence or false if there are no more items.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>boolean True if the current result is the next item from the sequence or false if there are no more items. </dd></dl>
<dl compact><dt><b>Exceptions:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>XPathException</em> </td><td>TYPE_ERR: raised if ResultType is not UNORDERED_NODE_ITERATOR_TYPE or ORDERED_NODE_ITERATOR_TYPE (XPath 1.0) or if ResultType is not ITERATOR_RESULT_TYPE (XPath 2.0). </td></tr>
<tr><td valign="top"></td><td valign="top"><em><a class="el" href="classDOMException.html">DOMException</a></em> </td><td>INVALID_STATE_ERR: The document has been mutated since the result was returned. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="6203550451cb9d2535e08e5f6c17a50a"></a><!-- doxytag: member="DOMXPathResult::getInvalidIteratorState" ref="6203550451cb9d2535e08e5f6c17a50a" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool DOMXPathResult::getInvalidIteratorState </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Signifies that the iterator has become invalid.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>invalidIteratorState True if ResultType is UNORDERED_NODE_ITERATOR_TYPE or ORDERED_NODE_ITERATOR_TYPE (XPath 1.0) or ITERATOR_RESULT_TYPE (XPath 2.0) and the document has been modified since this result was returned. </dd></dl>
<dl compact><dt><b>Exceptions:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>XPathException</em> </td><td>TYPE_ERR: raised if ResultType is not UNORDERED_NODE_ITERATOR_TYPE or ORDERED_NODE_ITERATOR_TYPE (XPath 1.0) or if ResultType is not ITERATOR_RESULT_TYPE (XPath 2.0). </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="ec8aab57f5eaddc7006f2944f39462f3"></a><!-- doxytag: member="DOMXPathResult::snapshotItem" ref="ec8aab57f5eaddc7006f2944f39462f3" args="(XMLSize_t index)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool DOMXPathResult::snapshotItem </td>
<td>(</td>
<td class="paramtype"><a class="el" href="Xerces__autoconf__config_8msvc_8hpp.html#c0f7e36996cd03eb43bcee10321f77cd">XMLSize_t</a> </td>
<td class="paramname"> <em>index</em> </td>
<td> ) </td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Sets the current result to the indexth item in the snapshot collection.
<p>
If index is greater than or equal to the number of items in the list, this method returns false. Unlike the iterator result, the snapshot does not become invalid, but may not correspond to the current document if it is mutated. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>index</em> </td><td>of type XMLSize_t - Index into the snapshot collection. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>boolean True if the current result is the next item from the sequence or false if there are no more items. </dd></dl>
<dl compact><dt><b>Exceptions:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>XPathException</em> </td><td>TYPE_ERR: raised if ResultType is not UNORDERED_NODE_SNAPSHOT_TYPE or ORDERED_NODE_SNAPSHOT_TYPE (XPath 1.0) or if ResultType is not SNAPSHOT_RESULT_TYPE (XPath 2.0). </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="229a90c6e18352c86b58e4889b559ec4"></a><!-- doxytag: member="DOMXPathResult::getSnapshotLength" ref="229a90c6e18352c86b58e4889b559ec4" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="Xerces__autoconf__config_8msvc_8hpp.html#c0f7e36996cd03eb43bcee10321f77cd">XMLSize_t</a> DOMXPathResult::getSnapshotLength </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The number of items in the result snapshot.
<p>
Valid values for snapshotItem indices are 0 to snapshotLength-1 inclusive. <dl class="return" compact><dt><b>Returns:</b></dt><dd>snapshotLength of type XMLSize_t </dd></dl>
<dl compact><dt><b>Exceptions:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>XPathException</em> </td><td>TYPE_ERR: raised if ResultType is not UNORDERED_NODE_SNAPSHOT_TYPE or ORDERED_NODE_SNAPSHOT_TYPE (XPath 1.0) or if ResultType is not SNAPSHOT_RESULT_TYPE (XPath 2.0). </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="42d33fccfa62eb579c2c86a42c0be310"></a><!-- doxytag: member="DOMXPathResult::release" ref="42d33fccfa62eb579c2c86a42c0be310" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void DOMXPathResult::release </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Called to indicate that this <a class="el" href="classDOMXPathResult.html" title="The DOMXPathResult interface represents the result of the evaluation of an XPath...">DOMXPathResult</a> is no longer in use and that the implementation may relinquish any resources associated with it.
<p>
Access to a released object will lead to unexpected result.
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="DOMXPathResult_8hpp-source.html">DOMXPathResult.hpp</a></ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Wed Apr 21 17:55:50 2010 for Xerces-C++ by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
</body>
</html>
|
