IXPathExpression.Evaluate

IXPathExpression.Evaluate method

Evaluates this XPath expression and returns a result.

public IXPathResult Evaluate(Node contextNode, XPathResultType type, object result)
ParameterTypeDescription
contextNodeNodeThe context is context node for the evaluation of this XPath expression. If the IXPathEvaluator was obtained by casting the Document then this must be owned by the same document and must be a Document, Element, Attr, Text, CDATASection, Comment, ProcessingInstruction, or XPathNamespace node. If the context node is a Text or a CDATASection, then the context is interpreted as the whole logical text node as seen by XPath, unless the node is empty in which case it may not serve as the XPath context.
typeXPathResultTypeIf a specific type is specified, then the result will be coerced to return the specified type relying on XPath conversions and fail if the desired coercion is not possible. This must be one of the values of XPathResultType.
resultObjectThe result specifies a specific result object which may be reused and returned by this method. If this is specified as null or the implementation does not reuse the specified result, a new result object will be constructed and returned. For XPath 1.0 results, this object will be of type IXPathResult.

Return Value

The result of the evaluation of the XPath expression. For XPath 1.0 results, this object will be of type IXPathResult.

Exceptions

exceptioncondition
DOMExceptionTYPE_ERR: Raised if the result cannot be converted to return the specified type.
DOMExceptionWRONG_DOCUMENT_ERR: The Node is from a document that is not supported by the IXPathEvaluator that created this IXPathExpression.
DOMExceptionNOT_SUPPORTED_ERR: The Node is not a type permitted as an XPath context node or the request type is not permitted by this IXPathExpression.

See Also