XQuery.Evaluate Method (IXPathNavigable)XQuery.Evaluate Method (IXPathNavigable)XQuery::Evaluate Method (IXPathNavigable^)
- XmlPrime 1.0
Syntax
Public Function Evaluate( _ contextItem As System.Xml.XPath.IXPathNavigable _ ) As XPathItemCollection
public XPathItemCollection Evaluate( System.Xml.XPath.IXPathNavigable contextItem )
public: XPathItemCollection^ Evaluate( System.Xml.XPath::IXPathNavigable^ contextItem )
Parameters
- contextItem
Type: System.Xml.XPath.IXPathNavigableSystem.Xml.XPath.IXPathNavigableSystem.Xml.XPath::IXPathNavigable^
The context item for the query.
Return Value
Type: XmlPrime.XPathItemCollectionXmlPrime.XPathItemCollectionXmlPrime::XPathItemCollection^
An XPathItemCollectionXPathItemCollectionXPathItemCollection representing the result of evaluating the XQuery program.
Exceptions
Exception | Condition |
ArgumentNullExceptionArgumentNullExceptionArgumentNullException | contextItem is null
a null reference (Nothing in Visual Basic)
nullptr . |
XdmExceptionXdmExceptionXdmException | An error occurred evaluating the query. |
Remarks
The items in the returned XPathItemCollectionXPathItemCollectionXPathItemCollection will all either be XPathNavigatorXPathNavigatorXPathNavigator instances (for nodes) or XPathAtomicValueXPathAtomicValueXPathAtomicValue instances (for atomic values).
The results of the query are only evaluated whilst they are enumerated. Any errors encountered during evaluation may be thrown from the MoveNextMoveNextMoveNext method and CurrentCurrentCurrent property of the enumerator over the XPathItemCollectionXPathItemCollectionXPathItemCollection.