IXPathResult class

IXPathResult class

The XPathResult interface represents the result of the evaluation of an XPath 1.0 expression within the context of a particular node. 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.

The IXPathResult type exposes the following members:

Properties

PropertyDescription
result_typeA code representing the type of this result, as defined by the
http://www.w3.org/TR/DOM-Level-3-XPath/xpath.html#XPathResult
XPathResultType enum.
number_valueThe value of this number result.
string_valueThe value of this string result.
boolean_valueThe value of this boolean result.
single_node_valueThe value of this single node result, which may be null.
invalid_iterator_stateSignifies that the iterator has become invalid. True if resultType
is UnorderedNodeIterator type or OrderedNodeIterator type and
the document has been modified since this result was returned.
snapshot_lengthThe number of nodes in the result snapshot. Valid values for snapshotItem
indices are 0 to snapshotLength-1 inclusive.

Methods

MethodDescription
iterate_nextIterates and returns the next node from the node set or null if there are no more nodes.
snapshot_itemReturns the indexth item in the snapshot collection. If index is greater than
or equal to the number of nodes in the list, this method returns null. Unlike the
iterator result, the snapshot does not become invalid, but may not correspond to the current
document if it is mutated.

See Also