13 Package XPath APIs for C

XPath methods process XPath related types and interfaces.

This chapter contains this section:

XPath Interface

See Also:

XPath Interface

Table 13-1 summarizes the methods available through the XPath interface.

CAXML6205 Table 13-1 Summary of XPath Methods

Function	Summary
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 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.

CAXML6206

XmlXPathCreateCtx()

Create an XPath context

CAXML6207Syntax

xpctx* XmlXPathCreateCtx(
   xmlctx *xsl,
   oratext *baseuri,
   xmlnode *ctxnode, 
   ub4 ctxpos, 
   ub4 ctxsize);

Parameter	In/Out	Description
xsl	IN	XSL stylesheet as `xmldoc` object
baseuri	IN	base URI used by document, if any
ctxnode	IN	current context position
ctxpos	IN	current context size
ctxsize	IN	current context node

CAXML6208Returns

(xpctx *) XPath context or NULL on error

CAXML6209

XmlXPathDestroyCtx()

Destroy an XPath context.

CAXML6210Syntax

void XmlXPathDestroyCtx(
   xpctx *xslxpctx);

Parameter	In/Out	Description
xslxpctx	IN	XPath context object

CAXML6211

XmlXPathEval()

Evaluate XPath expression.

CAXML6212Syntax

xpobj *XmlXPathEval(
   xpctx *xctx, 
   xpexpr *exprtree, 
   xmlerr *err);

Parameter	In/Out	Description
xctx	IN	`XPath` context
exprtree	IN	parsed `XPath` expression tree
err	OUT	error code

CAXML6213Returns

(xpobj *) result XPath object or NULL on error

CAXML6214

XmlXPathGetObjectBoolean()

Get boolean value of XPath object

CAXML6215Syntax

boolean XmlXPathGetObjectBoolean(
   xpobj *obj);

Parameter	In/Out	Description
obj	IN	XPath object

CAXML6216Returns

(boolean) truth value

CAXML6217

XmlXPathGetObjectFragment()

Get boolean value of XPath object

CAXML6218Syntax

xmlnode* XmlXPathGetObjectFragment(
   xpobj *obj);

Parameter	In/Out	Description
obj	IN	`XPath` object

CAXML6219Returns

(boolean) truth value

CAXML6220

XmlXPathGetObjectNSetNode()

Get node from nodeset-type XPath object

CAXML6221Syntax

xmlnode *XmlXPathGetObjectNSetNode(
   xpobj *obj,
   ub4 i);

Parameter	In/Out	Description
obj	IN	`XPath` object
i	IN	node index in nodeset

CAXML6222Returns

(xmlnode *) The object type or values.

CAXML6223

XmlXPathGetObjectNSetNum()

Get number of nodes in nodeset-type XPath object

CAXML6224Syntax

ub4 XmlXPathGetObjectNSetNum(
   xpobj *obj);

Parameter	In/Out	Description
obj	IN	`XPath` object

CAXML6225Returns

(ub4) number of nodes in nodeset

CAXML6226

XmlXPathGetObjectNumber()

Get number from XPath object

CAXML6227Syntax

double XmlXPathGetObjectNumber(
   xpobj *obj);

Parameter	In/Out	Description
obj	IN	`XPath` object

CAXML6228Returns

(double) number

CAXML6229

XmlXPathGetObjectString()

Get string from XPath object

CAXML6230Syntax

oratext *XmlXPathGetObjectString(
   xpobj *obj);

Parameter	In/Out	Description
obj	IN	XPath object

CAXML6231Returns

(oratext *) string

CAXML6232

XmlXPathGetObjectType()

Get XPath object type

CAXML6233Syntax

xmlxslobjtype XmlXPathGetObjectType(
   xpobj *obj);

Parameter	In/Out	Description
obj	IN	XPath object

CAXML6234Returns

(xmlxslobjtype) type-code for object

CAXML6235

XmlXPathParse()

Parse XPath expression.

CAXML6236Syntax

xpexpr* XmlXPathParse(
   xpctx *xctx,
   oratext *expr,
   xmlerr * err);

Parameter	In/Out	Description
xctx	IN	XPath context object
expr	IN	XPath expression
err	OUT	error code

CAXML6237Returns

(xpexpr *) XPath expression parse tree or NULL on error