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

Returns an XPathItemCollectionXPathItemCollectionXPathItemCollection representing the result of evaluating the XQuery program.

Syntax

Public Function Evaluate( _
    contextItem As System.Xml.XPath.XPathItem, _
    resultDocumentHandler As IResultDocumentHandler _
) As XPathItemCollection
public XPathItemCollection Evaluate(
    System.Xml.XPath.XPathItem contextItem,
    IResultDocumentHandler resultDocumentHandler
)
public:
XPathItemCollection^ 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.

Exceptions

ExceptionCondition
ArgumentNullExceptionArgumentNullExceptionArgumentNullExceptioncontextItem or resultDocumentHandler are 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.

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