Database XML C API Reference
ContentsOpens a new window
Opens a new window
Page 18 of 22

14 Package XPointer APIs for C

Package XPointer contains APIs for three interfaces.

This chapter contains these sections:

See Also:

XPointer Interface

Table 14-1Opens a new window summarizes the methods available through the XPointer interface.

Table 14-1 Summary of XPointer Methods; Package XPointer

Function Summary

XmlXPointerEval()Opens a new window

Evaluates xpointer string.

XmlXPointerEval()

Parses and evaluates xpointer string and calculates locations in the document.

Syntax

xmlxptrlocset* XmlXPointerEval(
   xmldocnode* doc,
   oratext* xptrstr);
Parameter In/Out Description 
doc

IN
document node of the corresponding DOM tree 
xptrstr

IN
xpointer string

Returns

(xmlxptrlocset *) calculated location set

XPtrLoc Interface

Table 14-2Opens a new window summarizes the methods available through the XPtrLoc interface.

Table 14-2 Summary of XPtrLoc Methods; Package XPointer

Function Summary

XmlXPtrLocGetNode()Opens a new window

Returns Xml node from XPtrLoc.

XmlXPtrLocGetPoint()Opens a new window

Returns Xml point from XPtrLoc.

XmlXPtrLocGetRange()Opens a new window

Returns Xml range from XPtrLoc.

XmlXPtrLocGetType()Opens a new window

Returns type of XPtrLoc.

XmlXPtrLocToString()Opens a new window

Returns string for a location.

XmlXPtrLocGetNode()

Returns node from location

Syntax

xmlnode* XmlXPtrLocGetNode(
   xmlxptrloc* loc);
Parameter In/Out Description 
loc

IN
location

Returns

(xmlnode *) Node from location

XmlXPtrLocGetPoint()

Returns point from location

Syntax

xmlpoint* XmlXPtrLocGetPoint(
   xmlxptrloc* loc);
Parameter In/Out Description 
loc

IN
location

Returns

(xmlpoint *) Point from location

XmlXPtrLocGetRange()

Returns range from location.

Syntax

xmlrange* XmlXPtrLocGetRange(
   xmlxptrloc* loc);
Parameter In/Out Description 
loc

IN
location

Returns

(xmlrange *) Range from location

XmlXPtrLocGetType()

Returns type of location

Syntax

xmlxptrloctype XmlXPtrLocGetType(
   xmlxptrloc* loc);
Parameter In/Out Description 
loc

IN
location

Returns

(xmlxptrloctype) Type of location

XmlXPtrLocToString()

Returns string for a location:

- node name: name of the container node

- names of container nodes: "not a location" otherwise

Syntax

oratext* XmlXPtrLocToString(
   xmlxptrloc* loc);
Parameter In/Out Description 
loc

IN
location

Returns

(oratext *) string

XPtrLocSet Interface

Table 14-3Opens a new window summarizes the methods available through the XPtrLocSet interface.

Table 14-3 Summary of XPtrLocSet Methods; Package XPointer

Function Summary

XmlXPtrLocSetFree()Opens a new window

Free a location set

XmlXPtrLocSetGetItem()Opens a new window

Returns location with idx position in XPtrLocSet

XmlXPtrLocSetGetLength()Opens a new window

Returns length of XPtrLocSet.

XmlXPtrLocSetFree()

It is user's responsibility to call this function on every location set returned by XPointer or XPtrLocSet interfaces

Syntax

void XmlXPtrLocSetFree(
   xmlxptrlocset* locset);
Parameter In/Out Description 
locset

IN
location set

XmlXPtrLocSetGetItem()

Returns location with idx position in the location set. First position is 1.

Syntax

xmlxptrloc* XmlXPtrLocSetGetItem(
   xmlxptrlocset* locset, 
   ub4 idx);
Parameter In/Out Description 
locset

IN
location set 
idx

IN
location index

Returns

(xmlxptrloc *) location with the position idx

XmlXPtrLocSetGetLength()

Returns the number of locations in the location set

Syntax

ub4 XmlXPtrLocSetGetLength(
   xmlxptrlocset* locset);
Parameter In/Out Description 
locset

IN
location set

Returns

(ub4) number of nodes in locset