13 C用のXPointer APIパッケージ

XPointerパッケージには、3つのインタフェースのAPIが含まれています。

この章の内容は次のとおりです。

• XPointerインタフェース

• XPtrLocインタフェース

• XPtrLocSetインタフェース

関連項目: 『Oracle XML Developer's Kitプログラマーズ・ガイド』 『Oracle XML DB開発者ガイド』

---

XPointerインタフェース

表13-1にXPointerインタフェースで使用できるメソッドの概要を示します。

表13-1 XPointerメソッドの概要: XPointerパッケージ

関数	概要
XmlXPointerEval()	xpointer文字列を評価します。

---

XmlXPointerEval()

xpointer文字列を解析および評価し、ドキュメント内での位置を計算します。

構文

xmlxptrlocset* XmlXPointerEval(
   xmldocnode* doc,
   oratext* xptrstr);

パラメータ	IN/OUT	説明
doc	IN	対応するDOMツリーのドキュメント・ノード
xptrstr	IN	xpointer文字列

戻り値

(xmlxptrlocset *) 計算した位置セット。

---

XPtrLocインタフェース

表13-2にXPtrLocインタフェースで使用できるメソッドの概要を示します。

表13-2 XPtrLocメソッドの概要: XPointerパッケージ

関数	概要
XmlXPtrLocGetNode()	XPtrLocからXmlノードを戻します。
XmlXPtrLocGetPoint()	XPtrLocからXmlポイントを戻します。
XmlXPtrLocGetRange()	XPtrLocからXmlの範囲を戻します。
XmlXPtrLocGetType()	XPtrLocの型を戻します。
XmlXPtrLocToString()	位置から文字列を戻します。

---

XmlXPtrLocGetNode()

位置からノードを戻します。

構文

xmlnode* XmlXPtrLocGetNode(
   xmlxptrloc* loc);

パラメータ	IN/OUT	説明
loc	IN	位置

戻り値

(xmlnode *) 位置のNode。

---

XmlXPtrLocGetPoint()

位置からポイントを戻します。

構文

xmlpoint* XmlXPtrLocGetPoint(
   xmlxptrloc* loc);

パラメータ	IN/OUT	説明
loc	IN	位置

戻り値

(xmlpoint *) 位置のポイント。

---

XmlXPtrLocGetRange()

位置から範囲を戻します。

構文

xmlrange* XmlXPtrLocGetRange(
   xmlxptrloc* loc);

パラメータ	IN/OUT	説明
loc	IN	位置

戻り値

(xmlrange *) 位置の範囲。

---

XmlXPtrLocGetType()

位置の型を戻します。

構文

xmlxptrloctype XmlXPtrLocGetType(
   xmlxptrloc* loc);

パラメータ	IN/OUT	説明
loc	IN	位置

戻り値

(xmlxptrloctype) 位置の型。

---

XmlXPtrLocToString()

位置から文字列を戻します。

- ノード名: コンテナ・ノードの名前。

- コンテナ・ノードの名前: それ以外の場合は位置ではありません。

構文

oratext* XmlXPtrLocToString(
   xmlxptrloc* loc);

パラメータ	IN/OUT	説明
loc	IN	位置

戻り値

(oratext *) 文字列。

---

XPtrLocSetインタフェース

表13-3にXPtrLocSetインタフェースで使用できるメソッドの概要を示します。

表13-3 XPtrLocSetメソッドの概要: XPointerパッケージ

関数	概要
XmlXPtrLocSetFree()	位置セットを解放します。
XmlXPtrLocSetGetItem()	XPtrLocSet内のidxの位置を戻します。
XmlXPtrLocSetGetLength()	XPtrLocSetの長さを戻します。

---

XmlXPtrLocSetFree()

XPointerまたはXPtrLocSetインタフェースによって戻されたすべての位置セットに対し、ユーザーが、この関数をコールする必要があります。

構文

void XmlXPtrLocSetFree(
   xmlxptrlocset* locset);

パラメータ	IN/OUT	説明
locset	IN	位置セット

---

XmlXPtrLocSetGetItem()

位置セット内のidxの位置を戻します。最初の位置は1です。

構文

xmlxptrloc* XmlXPtrLocSetGetItem(
   xmlxptrlocset* locset,
   ub4 idx);

パラメータ	IN/OUT	説明
locset	IN	位置セット
idx	IN	位置のインデックス

戻り値

(xmlxptrloc *) idxの位置。

---

XmlXPtrLocSetGetLength()

位置セット内の位置の数を戻します。

構文

ub4 XmlXPtrLocSetGetLength(
   xmlxptrlocset* locset);

パラメータ	IN/OUT	説明
locset	IN	位置セット

戻り値

(ub4) locset内のノードの数。