#include <xml/dom/xmlengxpathexpression.h>
| class RXmlEngXPathExpression |
| Public Member Enumerations | |
|---|---|
| enum | TXmlEngXPathExpressionPartType { EFunction, EPrefix } |
| Public Member Functions | |
|---|---|
| RXmlEngXPathExpression() | |
| void | Close() |
| IMPORT_C void | Destroy() |
| IMPORT_C RXmlEngXPathResult | EvaluateL(TXmlEngNode, const MXmlEngNamespaceResolver *) |
| IMPORT_C RXmlEngXPathResult | EvaluateWithDependenciesL(TXmlEngNode, RXmlEngNodeSet &, const MXmlEngNamespaceResolver *) |
| IMPORT_C void * | ExtendedContext() |
| IMPORT_C void | SetExtendedContext(void *) |
A compiled XPath expression is a textual expression transformed after syntactical analysis into some internal representation of the expression. The only missing element for evaluation of the expression is evaluation context: the context node (where to start) and an optional set of prefix-to-namespace bindings.
XPath Expressions are created and instantiated by the Evaluator:
See also: TXmlEngXPathEvaluator
See the XPath spec here: http://www.w3.org/TR/2004/NOTE-DOM-Level-3-XPath-20040226/xpath.html
| IMPORT_C RXmlEngXPathResult | EvaluateL | ( | TXmlEngNode | aContextNode, |
| const MXmlEngNamespaceResolver * | aResolver = NULL | |||
| ) | const | |||
Evaluates this expression.
Otherwise, any of the system wide errors.
| Parameter | Description |
|---|---|
| aContextNode | The node relative to which the expression is evaluated. |
| aResolver | Not supported in current API. Reserved for future use. |
Returns: Result of evaluation
| IMPORT_C RXmlEngXPathResult | EvaluateWithDependenciesL | ( | TXmlEngNode | aContextNode, |
| RXmlEngNodeSet & | aDependents, | |||
| const MXmlEngNamespaceResolver * | aResolver = NULL | |||
| ) | const | |||
Does the same thing as EvaluateL(), but also calculates the dependency list of the expression.
Otherwise, any of the system wide errors.
| Parameter | Description |
|---|---|
| aContextNode | The node relative to which the expression is evaluated. |
| aDependents | After the method has returned, contains set of nodes that the expression is dependent on. |
| aResolver | Not supported in current API. Reserved for future use. |
Returns: Result of evaluation
| IMPORT_C void * | ExtendedContext | ( | ) | const |
Gets extended context data for the expression currently being evaluated.
See also: SetExtendedContext
Returns: Extended context pointer or NULL if not sete
| IMPORT_C void | SetExtendedContext | ( | void * | aContext | ) |
Set context data for the expression currently being evaluated.
Extended Context is data set by API users and available for XPath extension functions. For more information:
See also: RXmlEngXPathExpression
| Parameter | Description |
|---|---|
| aContext | Extended context pointer |