Packages: All | Callback | DOM | Range | SAX | Schema | Traversal | XML | XPath | XPointer | XSLT | XSLTVM Functions | Datatypes

Package XPath


Interface XPath

Function Index

FunctionDescription
XmlXPathCreateCtx Create an XPath context
XmlXPathDestroyCtx Destroy an XPath context
XmlXPathEval Evaluate XPath expression
XmlXPathGetObjectBoolean Get boolean value of XPath object
XmlXPathGetObjectFragment Get fragment value of XPath object
XmlXPathGetObjectNSetNode Get node from nodeset-type XPath object
XmlXPathGetObjectNSetNum Get number of of nodes in nodeset-type XPath object
XmlXPathGetObjectNumber Get number from XPath object
XmlXPathGetObjectString Get string from XPath object
XmlXPathGetObjectType Get XPath object type
XmlXPathParse Parse XPath expression

XmlXPathCreateCtx

Name XmlXPathCreateCtx
Interface XPath
Purpose Create an XPath context
Prototype xpctx* XmlXPathCreateCtx(xmlctx *xsl, oratext *baseuri,
                     xmlnode *ctxnode, ub4 ctxpos, ub4 ctxsize);
Arguments
xsl  (IN)  XSL stylesheet as xmldoc object.
baseuri  (IN)  base URI used by document [if any]
ctxpos  (IN)  current context position.
ctxsize  (IN)  current context size
ctxnode  (IN)  current context node
Returns (xpctx *) XPath context or NULL on error
Description Create an XPath context

XmlXPathDestroyCtx

Name XmlXPathDestroyCtx
Interface XPath
Purpose Destroy an XPath context
Prototype void XmlXPathDestroyCtx(xpctx *xslxpctx);
Arguments
xslxpctx  (IN)  XPath context object.
Returns (void)
Description Destroy an XPath context.

XmlXPathEval

Name XmlXPathEval
Interface XPath
Purpose Evaluate XPath expression
Prototype xpobj *XmlXPathEval(xpctx *xctx, xpexpr *exprtree, xmlerr *err);
Arguments
xpctx  (IN)  XPath context
exprtree  (IN)  Parsed XPath expression tree
err  (OUT)  error code
Returns (xpobj *) result XPath object or NULL on error
Description Evaluate XPath expression.

XmlXPathGetObjectBoolean

Name XmlXPathGetObjectBoolean
Interface XPath
Purpose Get boolean value of XPath object
Prototype boolean XmlXPathGetObjectBoolean(xpobj *obj);
Arguments
xobj  (IN)  XPath object.
Returns (boolean) truth value
Description Get boolean value of XPath object

See Also XmlXPathGetObjectType, XmlXPathGetObjectNSetNum, XmlXPathGetObjectNSetNode, XmlXPathGetObjectNumber, XmlXPathGetObjectBoolean

XmlXPathGetObjectFragment

Name XmlXPathGetObjectFragment
Interface XPath
Purpose Get fragment value of XPath object
Prototype xmlnode* XmlXPathGetObjectFragment(xpobj *obj);
Arguments
xobj  (IN)  XPath object.
Returns (boolean) truth value
Description Get boolean value of XPath object

See Also XmlXPathGetObjectType, XmlXPathGetObjectNSetNum, XmlXPathGetObjectNSetNode, XmlXPathGetObjectNumber, XmlXPathGetObjectBoolean

XmlXPathGetObjectNSetNode

Name XmlXPathGetObjectNSetNode
Interface XPath
Purpose Get node from nodeset-type XPath object
Prototype xmlnode *XmlXPathGetObjectNSetNode(xpobj *obj, ub4 i);
Arguments
xobj  (IN)  XPath object
i  (IN)  node index in nodeset
Returns (xmlnode *) The object type or values.
Description Get node from nodeset-type XPath object

See Also XmlXPathGetObjectType, XmlXPathGetObjectNSetNum, XmlXPathGetObjectString, XmlXPathGetObjectNumber, XmlXPathGetObjectBoolean

XmlXPathGetObjectNSetNum

Name XmlXPathGetObjectNSetNum
Interface XPath
Purpose Get number of of nodes in nodeset-type XPath object
Prototype ub4 XmlXPathGetObjectNSetNum(xpobj *obj);
Arguments
xobj  (IN)  XPath object (nodeset)
Returns (ub4) number of nodes in nodeset
Description Get number of of nodes in nodeset-type XPath object

See Also XmlXPathGetObjectType, XmlXPathGetObjectNSetNode, XmlXPathGetObjectString, XmlXPathGetObjectNumber, XmlXPathGetObjectBoolean

XmlXPathGetObjectNumber

Name XmlXPathGetObjectNumber
Interface XPath
Purpose Get number from XPath object
Prototype double XmlXPathGetObjectNumber(xpobj *obj);
Arguments
xobj  (IN)  XPath object.
Returns (double) number
Description Get number from XPath object

See Also XmlXPathGetObjectType, XmlXPathGetObjectNSetNum, XmlXPathGetObjectNSetNode, XmlXPathGetObjectString, XmlXPathGetObjectBoolean

XmlXPathGetObjectString

Name XmlXPathGetObjectString
Interface XPath
Purpose Get string from XPath object
Prototype oratext *XmlXPathGetObjectString(xpobj *obj);
Arguments
xobj  (IN)  XPath object.
Returns (oratext *) string
Description Get string from XPath object

See Also XmlXPathGetObjectType, XmlXPathGetObjectNSetNum, XmlXPathGetObjectNSetNode, XmlXPathGetObjectNumber, XmlXPathGetObjectBoolean

XmlXPathGetObjectType

Name XmlXPathGetObjectType
Interface XPath
Purpose Get XPath object type
Prototype xmlxslobjtype XmlXPathGetObjectType(xpobj *obj);
Arguments
xobj  (IN)  XPath object
Returns (xmlxslobjtype) type-code for object
Description Get XPath object type

See Also XmlXPathGetObjectNSetNum, XmlXPathGetObjectNSetNode, XmlXPathGetObjectString, XmlXPathGetObjectNumber, XmlXPathGetObjectBoolean

XmlXPathParse

Name XmlXPathParse
Interface XPath
Purpose Parse XPath expression
Prototype xpexpr* XmlXPathParse(xpctx *xctx, oratext *expr,  xmlerr * err);
Arguments
xpctx  (IN)  XPath context object
expr  (IN)  XPath expression
err  (OUT)  error code
Returns (xpexpr *) XPath expression parse tree or NULL on error
Description Parse XPath expression.