Skip Headers
Oracle® Database XML C API Reference
11g Release 2 (11.2)

Part Number E10770-02
Go to Documentation Home
Home
Go to Book List
Book List
Go to Table of Contents
Contents
Go to Index
Index
Go to Master Index
Master Index
Go to Feedback page
Contact Us

Go to previous page
Previous
Go to next page
Next
PDF · Mobi · ePub
CAXML01200

14 Package XPointer APIs for C

Package XPointer contains APIs for three interfaces.

This chapter contains these sections:

See Also:

CAXML6238

XPointer Interface

Table 14-1 summarizes the methods available through the XPointer interface.

CAXML6239Table 14-1 Summary of XPointer Methods; Package XPointer

Function Summary

XmlXPointerEval()

Evaluates xpointer string.


CAXML6240

XmlXPointerEval()

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

CAXML6241Syntax

xmlxptrlocset* XmlXPointerEval(
   xmldocnode* doc,
   oratext* xptrstr);
Parameter In/Out Description
doc
IN
document node of the corresponding DOM tree
xptrstr
IN
xpointer string

CAXML6242Returns

(xmlxptrlocset *) calculated location set

CAXML6243

XPtrLoc Interface

Table 14-2 summarizes the methods available through the XPtrLoc interface.

CAXML6244Table 14-2 Summary of XPtrLoc Methods; Package XPointer

Function Summary

XmlXPtrLocGetNode()

Returns Xml node from XPtrLoc.

XmlXPtrLocGetPoint()

Returns Xml point from XPtrLoc.

XmlXPtrLocGetRange()

Returns Xml range from XPtrLoc.

XmlXPtrLocGetType()

Returns type of XPtrLoc.

XmlXPtrLocToString()

Returns string for a location.


CAXML6245

XmlXPtrLocGetNode()

Returns node from location

CAXML6246Syntax

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

CAXML6247Returns

(xmlnode *) Node from location

CAXML6248

XmlXPtrLocGetPoint()

Returns point from location

CAXML6249Syntax

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

CAXML6250Returns

(xmlpoint *) Point from location

CAXML6251

XmlXPtrLocGetRange()

Returns range from location.

CAXML6252Syntax

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

CAXML6253Returns

(xmlrange *) Range from location

CAXML6254

XmlXPtrLocGetType()

Returns type of location

CAXML6255Syntax

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

CAXML6256Returns

(xmlxptrloctype) Type of location

CAXML6257

XmlXPtrLocToString()

Returns string for a location:

- node name: name of the container node

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

CAXML6258Syntax

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

CAXML6259Returns

(oratext *) string

CAXML6260

XPtrLocSet Interface

Table 14-3 summarizes the methods available through the XPtrLocSet interface.

CAXML6261Table 14-3 Summary of XPtrLocSet Methods; Package XPointer

Function Summary

XmlXPtrLocSetFree()

Free a location set

XmlXPtrLocSetGetItem()

Returns location with idx position in XPtrLocSet

XmlXPtrLocSetGetLength()

Returns length of XPtrLocSet.


CAXML6262

XmlXPtrLocSetFree()

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

CAXML6263Syntax

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

CAXML6264

XmlXPtrLocSetGetItem()

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

CAXML6265Syntax

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

CAXML6266Returns

(xmlxptrloc *) location with the position idx

CAXML6267

XmlXPtrLocSetGetLength()

Returns the number of locations in the location set

CAXML6268Syntax

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

CAXML6269Returns

(ub4) number of nodes in locset

Reader Comment

   

Comments, corrections, and suggestions are forwarded to authors every week. By submitting, you confirm you agree to the terms and conditions. Use the OTN forums for product questions. For support or consulting, file a service request through My Oracle Support.

Hide Navigation

Quick Lookup

Database Library · Master Index · Master Glossary · Book List · Data Dictionary · SQL Keywords · Initialization Parameters · Advanced Search · Error Messages

Main Categories

This Page

This Document

New and changed documents:
RSS Feed HTML RSS Feed PDF