XQuery.Evaluate Method (XPathItem, IResultDocumentHandler)XQuery.Evaluate Method (XPathItem, IResultDocumentHandler)XQuery::Evaluate Method (XPathItem^, IResultDocumentHandler^)

Returns an IEnumerable<T>IEnumerable(Of T)IEnumerable<T> representing the result of evaluating the XQuery program.

Namespace: XmlPrime XmlPrime XmlPrime
Assembly: XmlPrime (in XmlPrime.dll)

Syntax

Public Function Evaluate( _
    contextItem As System.Xml.XPath.XPathItem, _
    resultDocumentHandler As IResultDocumentHandler _
) As IEnumerable(Of System.Xml.XPath.XPathItem)

public IEnumerable<System.Xml.XPath.XPathItem> Evaluate(
    System.Xml.XPath.XPathItem contextItem,
    IResultDocumentHandler resultDocumentHandler
)

public:
IEnumerable<System.Xml.XPath::XPathItem^>^ Evaluate(
    System.Xml.XPath::XPathItem^ contextItem, 
    IResultDocumentHandler^ resultDocumentHandler
)

Parameters

contextItem

Type: System.Xml.XPath.XPathItemSystem.Xml.XPath.XPathItemSystem.Xml.XPath::XPathItem^

The initial context item for the query.

resultDocumentHandler

Type: XmlPrime.IResultDocumentHandlerXmlPrime.IResultDocumentHandlerXmlPrime::IResultDocumentHandler^

The result document handler.

Return Value

Type: System.Collections.Generic.IEnumerable<T>System.Collections.Generic.IEnumerable(Of T)System.Collections.Generic::IEnumerable<T>^

An IEnumerable<T>IEnumerable(Of T)IEnumerable<T> representing the result of evaluating the XQuery program.

Exceptions

Exception	Condition
ArgumentNullException ArgumentNullException ArgumentNullException	contextItem or resultDocumentHandler are `null` a null reference (`Nothing` in Visual Basic) `nullptr`.
XdmException XdmException XdmException	An error occurred evaluating the query.

Remarks

The results of the query are only evaluated whilst they are enumerated. Any errors encountered during evaluation may be thrown from the MoveNext MoveNext MoveNext method and Current Current Current property of the enumerator over the IEnumerable<T>IEnumerable(Of T)IEnumerable<T>.

The items in the returned IEnumerable<T>IEnumerable(Of T)IEnumerable<T> will all be instances of XPathNavigator XPathNavigator XPathNavigator (if the expression returns a node), XPathAtomicValue XPathAtomicValue XPathAtomicValue (if the expression returns an atomic value) or XPathFunctionItem XPathFunctionItem XPathFunctionItem (if the expression returns a function item).

This method is suitable for queries which use fn:put.