XML C用のXPointer APIパッケージ

14 XML C用のXPointer APIパッケージ

XPointerパッケージの各メソッドはXML C API用のXMLポインタを実装します。3つのインタフェース・タイプにグループ化されています。

14.1 XPointer XML C APIのXPointerインタフェース

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

表14-1 XML C実装のXPointer XPointerメソッドの概要

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

14.1.1 XmlXPointerEval()

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

構文

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

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

戻り値

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

14.2 XPointer XML C APIのXPtrLocインタフェース

次の表にXPointer XML C APIのXPtrLocインタフェースで使用できるメソッドの概要を示します。

表14-2 XML C実装のXPtrLoc XPointerメソッドの概要

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

14.2.1 XmlXPtrLocGetNode()

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

構文

xmlnode* XmlXPtrLocGetNode(
   xmlxptrloc* loc);

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

戻り値

(xmlnode *) 位置のNode。

14.2.2 XmlXPtrLocGetPoint()

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

構文

xmlpoint* XmlXPtrLocGetPoint(
   xmlxptrloc* loc);

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

戻り値

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

14.2.3 XmlXPtrLocGetRange()

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

構文

xmlrange* XmlXPtrLocGetRange(
   xmlxptrloc* loc);

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

戻り値

(xmlrange *) 位置の範囲。

14.2.4 XmlXPtrLocGetType()

位置の型を戻します。

構文

xmlxptrloctype XmlXPtrLocGetType(
   xmlxptrloc* loc);

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

戻り値

(xmlxptrloctype) 位置の型。

14.2.5 XmlXPtrLocToString()

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

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

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

構文

oratext* XmlXPtrLocToString(
   xmlxptrloc* loc);

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

戻り値

(oratext *) 文字列

14.3 XPointer XML C APIのXPtrLocSetインタフェース

次の表にXPointer XML C APIのXPtrLocSetインタフェースで使用できるメソッドの概要を示します。

表14-3 XML C実装のXPtrLocSet XPointerメソッドの概要

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

14.3.1 XmlXPtrLocSetFree()

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

構文

void XmlXPtrLocSetFree(
   xmlxptrlocset* locset);

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

14.3.2 XmlXPtrLocSetGetItem()

位置セット内のidxの位置を戻します。First position is 1.

構文

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

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

戻り値

(xmlxptrloc *) idxの位置。

14.3.3 XmlXPtrLocSetGetLength()

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

構文

ub4 XmlXPtrLocSetGetLength(
   xmlxptrlocset* locset);

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

戻り値

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