Packages: All | XPointer Functions | Datatypes

Package XPointer

Member Function Index

InterfaceFunctionDescription
XPointer  XmlXPointerEval  Evaluates xpointer string
XPtrLoc  XmlXPtrLocGetNode  Returns xmlnode from XPtrLoc
XPtrLoc  XmlXPtrLocGetPoint  Returns xmlpoint from XPtrLoc
XPtrLoc  XmlXPtrLocGetRange  Returns xmlrange from XPtrLoc
XPtrLoc  XmlXPtrLocGetType  Returns type of XPtrLoc
XPtrLoc  XmlXPtrLocToString  Returns string for a location
XPtrLocSet  XmlXPtrLocSetFree  Free a location set
XPtrLocSet  XmlXPtrLocSetGetItem  Returns location with idx position in XPtrLocSet
XPtrLocSet  XmlXPtrLocSetGetLength  Returns length of XPtrLocSet

Interface XPointer

Member Function Index

FunctionDescription
XmlXPointerEval Evaluates xpointer string

Interface XPtrLoc

Member Function Index

FunctionDescription
XmlXPtrLocGetNode Returns xmlnode from XPtrLoc
XmlXPtrLocGetPoint Returns xmlpoint from XPtrLoc
XmlXPtrLocGetRange Returns xmlrange from XPtrLoc
XmlXPtrLocGetType Returns type of XPtrLoc
XmlXPtrLocToString Returns string for a location

Interface XPtrLocSet

Member Function Index

FunctionDescription
XmlXPtrLocSetFree Free a location set
XmlXPtrLocSetGetItem Returns location with idx position in XPtrLocSet
XmlXPtrLocSetGetLength Returns length of XPtrLocSet

XmlXPointerEval

Name XmlXPointerEval
Interface XPointer
Purpose Evaluates xpointer string
Prototype xmlxptrlocset* XmlXPointerEval(xmldocnode* doc, oratext* xptrstr);
Arguments
doc  (IN)  document node of the corresponding DOM tree
xptrstr  (IN)  xpointer string
Returns (xmlxptrlocset *) calculated location set
Description Parses and evaluates xpointer string and calculates locations in the document

XmlXPtrLocGetNode

Name XmlXPtrLocGetNode
Interface XPtrLoc
Purpose Returns xmlnode from XPtrLoc
Prototype xmlnode* XmlXPtrLocGetNode(xmlxptrloc* loc);
Arguments
loc  (IN)  location
Returns (xmlnode *) Node from location
Description Returns node from location

XmlXPtrLocGetPoint

Name XmlXPtrLocGetPoint
Interface XPtrLoc
Purpose Returns xmlpoint from XPtrLoc
Prototype xmlpoint* XmlXPtrLocGetPoint(xmlxptrloc* loc);
Arguments
loc  (IN)  location
Returns (xmlpoint *) Point from location
Description Returns point from location

XmlXPtrLocGetRange

Name XmlXPtrLocGetRange
Interface XPtrLoc
Purpose Returns xmlrange from XPtrLoc
Prototype xmlrange* XmlXPtrLocGetRange(xmlxptrloc* loc);
Arguments
loc  (IN)  location
Returns (xmlrange *) Range from location
Description Returns range from location

XmlXPtrLocGetType

Name XmlXPtrLocGetType
Interface XPtrLoc
Purpose Returns type of XPtrLoc
Prototype xmlxptrloctype XmlXPtrLocGetType(xmlxptrloc* loc);
Arguments
loc  (IN)  location
Returns (xmlxptrloctype) Type of location
Description Returns type of location

XmlXPtrLocToString

Name XmlXPtrLocToString
Interface XPtrLoc
Purpose Returns string for a location
Prototype oratext* XmlXPtrLocToString(xmlxptrloc* loc);
Arguments
loc  (IN)  location
Returns (oratext *) string
Description Returns string for a location: - node name - name of the container node - names of container nodes - "not a location" otherwise

XmlXPtrLocSetFree

Name XmlXPtrLocSetFree
Interface XPtrLocSet
Purpose Free a location set
Prototype void XmlXPtrLocSetFree(xmlxptrlocset* locset);
Arguments
locset  (IN)  location set
Returns (void)
Description It is user reponsibility to call this function on every location set returned by XPointer or XPtrLocSet interfaces

XmlXPtrLocSetGetItem

Name XmlXPtrLocSetGetItem
Interface XPtrLocSet
Purpose Returns location with idx position in XPtrLocSet
Prototype xmlxptrloc* XmlXPtrLocSetGetItem(xmlxptrlocset* locset, ub4 idx);
Arguments
locset  (IN)  location set
idx  (IN)  location index
Returns (xmlxptrloc *) location with the position idx
Description Returns location with idx position in the location set. First posistion is 1.

XmlXPtrLocSetGetLength

Name XmlXPtrLocSetGetLength
Interface XPtrLocSet
Purpose Returns length of XPtrLocSet
Prototype ub4 XmlXPtrLocSetGetLength(xmlxptrlocset* locset);
Arguments
locset  (IN)  location set
Returns (ub4) number of nodes in locset
Description Returns the number of locations in the location set