4 XML C用のイベントAPIパッケージ
次の表にXML C APIのEvent
インタフェースで使用できるメソッドの概要を示します。
表4-1 XML C実装のEventメソッドの概要
関数 | 概要 |
---|---|
解析操作に関連のある内部構造をクリーン・アップします。これにより、イベント・コンテキストは破棄されません。イベント・コンテキストは、このコールの後に再利用できます。 |
|
イベント・コンテキストをプル解析モードで作成します。 |
|
ストリーム・バリデータ用のイベント・コンテキストを作成します。 |
|
イベント・コンテキストを破棄します。解析を終了します。解析操作中いつでもコールできます。 |
|
ストリーム・バリデータによって作成されたイベント・コンテキストを終了します。 |
|
|
|
属性宣言 |
|
属性宣言 |
|
属性宣言 |
|
属性宣言 |
|
属性宣言 |
|
属性宣言 |
|
属性宣言 |
|
属性宣言 |
|
属性宣言 |
|
属性宣言 |
|
属性宣言 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
指定されたエンコーディングの値を戻します。 |
|
XmlEvNext()によって |
|
|
|
|
|
|
|
|
|
解析時の位置を入力ストリームおよびそのパスの行番号の |
|
|
|
|
|
|
|
|
|
汎用エンティティが宣言されたかどうか( |
|
PE宣言 |
|
PE宣言 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
次のイベントを取得し、パーサーを進めます。 |
|
パーサーを次のタグ・イベントに進めます。 |
|
新しいドキュメントをロードし、プル解析用に構成します。 |
|
イベントによって表されるXML文書を検証します。 |
4.1 XmlEvCleanPPCtx()
解析操作に関連のある内部構造をクリーン・アップします。これにより、イベント・コンテキストは破棄されません。イベント・コンテキストは、このコールの後に再利用できます。
構文
xmlerr XmlEvCleanPPCtx( xmlctx *xctx, xmlevctx *evctx);
パラメータ | In/Out | 説明 |
---|---|---|
xctx |
IN |
XMLコンテキスト |
evtx |
IN |
XmlEventsコンテキスト |
戻り値
(xmlerr)
エラー番号。
4.2 XmlEvCreatePPCtx()
イベント・コンテキストをプル解析モードで作成します。
XmlEvLoadPPDocを使用してドキュメントがロードされます。実際の解析は、XmlEvNext()への複数のコールによって進められます。各コールの後に、様々なXmlEvGet
XXX
()関数へのコールによって関連情報が取得される場合があります。プロパティの基本セットは、XmlLoadDom
と同じです。入力ソースは、XmlEvLoadPPDoc()コールで指定される必要があります。
構文
xmlevctx *XmlEvCreatePPCtx(
xmlctx *xctx,
xmlerr *xerr,
list);
パラメータ | In/Out | 説明 |
---|---|---|
xctx |
IN |
XMLコンテキスト |
xerr |
IN |
数値のエラー・コード。正常に終了した場合は、 |
list |
IN |
これらの追加プロパティは、
これらのオプション・パラメータは、次のように使用してください。 xmlevctx *XmlEvCreatePPCtx( xmlctx *xctx, xmlerr *xerr, ("expand_entities", mode), ("use_buffer", buffer), ("use_buffer_len", length), ("get_id_callback", function), ("raw_buffer_len", length), ("error_callback", callback) ); |
戻り値
(xmlevctx)
XmlEvNext()への後続コールに渡されるイベント・コンテキスト。
4.3 XmlEvCreateSVCtx()
ストリーム・バリデータ用のイベント・コンテキストを作成します。ストリーム・バリデータを初期化し、後続のコールで使用できるイベント・コンテキストを戻します。
XmlEvDestroySVCtx()XmlEvDestroySVCtx()とともに使用します。これは透過的なメソッドです。かわりに不透過なXmlEvSchemaValidate()XmlEvSchemaValidate()を使用することもできます。
構文
xmlevctx *XmlEvCreateSVCtx( xmlctx *xctx, xsdctx *sctx, xmlevctx *docEvCtx, xmlerr *err);
パラメータ | In/Out | 説明 |
---|---|---|
xctx |
IN |
XMLコンテキスト。有効である必要があります。 |
sctx |
IN |
スキーマ・コンテキスト。有効である必要があります。 |
docEvCtx |
IN |
検証されるドキュメントのイベント・コンテキスト |
err |
OUT |
数値のエラー・コード。正常に終了した場合は、 |
戻り値
(xmlevctx)
XmlEvNext()XmlEvNext()への後続コールに渡されるイベント・コンテキスト
4.4 XmlEvDestroyPPCtx()
イベント・コンテキストを破棄します。解析を終了します。解析操作中いつでもコールできます。
構文
void XmlEvDestroyPPCtx( xmlevctx *evctx);
パラメータ | In/Out | 説明 |
---|---|---|
evctx |
IN |
XMLイベント・コンテキスト |
4.5 XmlEvDestroySVCtx()
ストリーム・バリデータによって作成されたイベント・コンテキストを終了します。正常に終了した場合は、XMLERR_OK [0]
を戻し、失敗時には数値のエラー・コードを戻します。
XmlEvCreateSVCtx()XmlEvCreateSVCtx()とともに使用します。これは透過的なメソッドです。かわりに不透過なXmlEvSchemaValidate()XmlEvSchemaValidate()を使用することもできます。
構文
xmlerr XmlEvDestroySVCtx( xmlctx *xctx, xmlevctx *evCtx);
パラメータ | In/Out | 説明 |
---|---|---|
xctx |
IN |
XMLコンテキスト |
evCtx |
IN |
終了されたイベント・コンテキスト |
戻り値
(xmlerr)
エラー番号。
4.6 XmlEvGetAttrCount()
XML_EVENT_START_ELEMENT
イベントの属性数を取得します。
構文
ub4 XmlEvGetAttrCount( xmlevctx *evctx);
パラメータ | In/Out | 説明 |
---|---|---|
evctx |
IN |
XMLイベント・コンテキスト |
戻り値
(ub4)
属性数。
4.7 XmlEvGetAttrDeclBody()
属性宣言XML_EVENT_ATTLIST_DECLARATION
の属性本体を取得します。また、長さをOUT len
パラメータとして提供します。
構文
oratext *XmlEvGetAttrDeclBody( xmlevctx *evctx, ub4 index, ub4 *len);
パラメータ | In/Out | 説明 |
---|---|---|
evctx |
IN |
XMLイベント・コンテキスト |
index |
IN |
属性のインデックス |
len |
OUT |
長さ |
戻り値
(oratext *)
宣言本体。
4.8 XmlEvGetAttrDeclBody0()
属性宣言XML_EVENT_ATTLIST_DECLARATION
のNULL
で終了する属性本体を取得します。
構文
oratext *XmlEvGetAttrDeclBody0( xmlevctx *evctx, ub4 index);
パラメータ | In/Out | 説明 |
---|---|---|
evctx |
IN |
XMLイベント・コンテキスト |
index |
IN |
属性のインデックス |
戻り値
(oratext *)
宣言本体。
4.9 XmlEvGetAttrDeclCount()
属性宣言XML_EVENT_ATTLIST_DECLARATION
の属性数を取得します。
構文
ub4 XmlEvGetAttrDeclCount( xmlevctx *evctx);
パラメータ | In/Out | 説明 |
---|---|---|
evctx |
IN |
XMLイベント・コンテキスト |
戻り値
(ub4)
属性数。
4.10 XmlEvGetAttrDeclElName()
属性宣言XML_EVENT_ATTLIST_DECLARATION
の要素名を取得します。また、長さをOUT len
パラメータとして提供します。
構文
oratext *XmlEvGetAttrDeclElName( xmlevctx *evctx, ub4 *len);
パラメータ | In/Out | 説明 |
---|---|---|
evctx |
IN |
XMLイベント・コンテキスト |
len |
OUT |
長さ |
戻り値
(oratext *)
要素名。
4.11 XmlEvGetAttrDeclElName0()
属性宣言XML_EVENT_ATTLIST_DECLARATION
のNULL
で終了する要素名を取得します。
構文
oratext *XmlEvGetAttrDeclElName0( xmlevctx *evctx);
パラメータ | In/Out | 説明 |
---|---|---|
evctx |
IN |
XMLイベント・コンテキスト |
戻り値
(oratext *)
要素名。
4.12 XmlEvGetAttrDeclLocalName()
属性宣言イベントXML_EVENT_ATTLIST_DECLARATION
のローカル名を取得します。また、長さをOUT len
パラメータとして提供します。
構文
oratext *XmlEvGetAttrDeclLocalName( xmlevctx *evctx, ub4 index ub4 *len);
パラメータ | In/Out | 説明 |
---|---|---|
evctx |
IN |
XMLイベント・コンテキスト |
index |
IN |
属性のインデックス |
len |
OUT |
長さ |
戻り値
(oratext *)
ローカル名。
4.13 XmlEvGetAttrDeclLocalName0()
属性宣言イベントXML_EVENT_ATTLIST_DECLARATION
のNULL
で終了するローカル名を取得します。
構文
oratext *XmlEvGetAttrDeclLocalName0( xmlevctx *evctx, ub4 index);
パラメータ | In/Out | 説明 |
---|---|---|
evctx |
IN |
XMLイベント・コンテキスト |
index |
IN |
属性のインデックス |
戻り値
(oratext *)
ローカル名。
4.14 XmlEvGetAttrDeclName()
属性宣言XML_EVENT_ATTLIST_DECLARATION
の属性名を取得します。また、長さをOUT len
パラメータとして提供します。
構文
oratext *XmlEvGetAttrDeclName( xmlevctx *evctx, ub4 index ub4 *len);
パラメータ | In/Out | 説明 |
---|---|---|
evctx |
IN |
XMLイベント・コンテキスト |
index |
IN |
属性のインデックス |
len |
OUT |
長さ |
戻り値
(oratext *)
属性名。
4.15 XmlEvGetAttrDeclName0()
属性宣言XML_EVENT_ATTLIST_DECLARATION
のNULL
で終了する属性名を取得します。
構文
oratext *XmlEvGetAttrDeclName0( xmlevctx *evctx, ub4 index);
パラメータ | In/Out | 説明 |
---|---|---|
evctx |
IN |
XMLイベント・コンテキスト |
index |
IN |
属性のインデックス |
戻り値
(oratext *)
属性名。
4.16 XmlEvGetAttrDeclPrefix()
属性宣言XML_EVENT_ATTLIST_DECLARATION
の属性接頭辞を取得します。また、長さをOUT len
パラメータとして提供します。
構文
oratext *XmlEvGetAttrDeclPrefix( xmlevctx *evctx, ub4 index ub4 *len);
パラメータ | In/Out | 説明 |
---|---|---|
evctx |
IN |
XMLイベント・コンテキスト |
index |
IN |
属性のインデックス |
len |
OUT |
長さ |
戻り値
(oratext *)
属性接頭辞。
4.17 XmlEvGetAttrDeclPrefix0()
属性宣言XML_EVENT_ATTLIST_DECLARATION
のNULL
で終了する属性接頭辞を取得します。
構文
oratext *XmlEvGetAttrDeclPrefix0( xmlevctx *evctx, ub4 index);
パラメータ | In/Out | 説明 |
---|---|---|
evctx |
IN |
XMLイベント・コンテキスト |
index |
IN |
属性のインデックス |
戻り値
(oratext *)
属性接頭辞。
4.18 XmlEvGetAttrID()
XML_EVENT_START_ELEMENT
イベントの、属性のQNAME
の識別子を取得します。XmlEvCreatePPCtx()で指定されたユーザー定義のIDコールバックを起動します。コールバックが指定されていない場合、0
(ゼロ)を戻します。
構文
sb8 XmlEvGetAttrID( xmlevctx *evctx ub4 index);
パラメータ | In/Out | 説明 |
---|---|---|
evctx |
IN |
XMLイベント・コンテキスト |
index |
IN |
属性のインデックス |
戻り値
(sb8)
識別子。
4.19 XmlEvGetAttrLocalName()
XML_EVENT_START_ELEMENT
イベントの属性ローカル名を取得します。また、長さをOUT len
パラメータとして提供します。
構文
oratext *XmlEvGetAttrLocalName( xmlevctx *evctx, ub4 index ub4 *len);
パラメータ | In/Out | 説明 |
---|---|---|
evctx |
IN |
XMLイベント・コンテキスト |
index |
IN |
属性のインデックス。 |
len |
OUT |
長さ |
戻り値
(oratext *)
属性名。
4.20 XmlEvGetAttrLocalName0()
XML_EVENT_START_ELEMENT
イベントのNULL
で終了する属性ローカル名を取得します。
構文
oratext *XmlEvGetAttrLocalName0( xmlevctx *evctx, ub4 index);
パラメータ | In/Out | 説明 |
---|---|---|
evctx |
IN |
XMLイベント・コンテキスト |
index |
IN |
属性のインデックス。 |
戻り値
(oratext *)
属性名。
4.21 XmlEvGetAttrName()
XML_EVENT_START_ELEMENT
イベントの属性名を取得します。また、長さをOUT len
パラメータとして提供します。
構文
oratext *XmlEvGetAttrName( xmlevctx *evctx, ub4 index ub4 *len);
パラメータ | In/Out | 説明 |
---|---|---|
evctx |
IN |
XMLイベント・コンテキスト |
index |
IN |
属性のインデックス。 |
len |
OUT |
長さ |
戻り値
(oratext *)
属性名。
4.22 XmlEvGetAttrName0()
XML_EVENT_START_ELEMENT
イベントのNULL
で終了する属性名を取得します。
構文
oratext *XmlEvGetAttrName0( xmlevctx *evctx, ub4 index);
パラメータ | In/Out | 説明 |
---|---|---|
evctx |
IN |
XMLイベント・コンテキスト |
index |
IN |
属性のインデックス。 |
戻り値
(oratext *)
属性名。
4.23 XmlEvGetAttrPrefix()
XML_EVENT_START_ELEMENT
イベントの接頭辞タグを取得し、イベントの長さをOUT len
パラメータとして戻します。
構文
oratext *XmlEvGetAttrPrefix( xmlevctx *evctx, ub4 index, ub4 *len);
パラメータ | In/Out | 説明 |
---|---|---|
evctx |
IN |
XMLイベント・コンテキスト |
index |
IN |
属性のインデックス |
len |
OUT |
イベント名の長さ |
戻り値
(oratext *)
属性接頭辞。
4.24 XmlEvGetAttrPrefix0()
XML_EVENT_START_ELEMENT
イベントのNULL
で終了する属性接頭辞を取得します。
構文
oratext *XmlEvGetAttrPrefix0( xmlevctx *evctx);
パラメータ | In/Out | 説明 |
---|---|---|
evctx |
IN |
XMLイベント・コンテキスト |
index |
IN |
属性のインデックス |
戻り値
(oratext *)
属性接頭辞。
4.25 XmlEvGetAttrURI()
XML_EVENT_START_ELEMENT
イベントの属性URIを取得します。また、長さをOUT len
パラメータとして提供します。
構文
oratext *XmlEvGetAttrURI( xmlevctx *evctx, ub4 index ub4 *len);
パラメータ | In/Out | 説明 |
---|---|---|
evctx |
IN |
XMLイベント・コンテキスト |
index |
IN |
属性のインデックス |
len |
OUT |
長さ |
戻り値
(oratext *)
属性URI。
4.26 XmlEvGetAttrURI0()
XML_EVENT_START_ELEMENT
イベントのNULL
で終了する属性URIを取得します。
構文
oratext *XmlEvGetAttrURI0( xmlevctx *evctx, ub4 index);
パラメータ | In/Out | 説明 |
---|---|---|
evctx |
IN |
XMLイベント・コンテキスト |
index |
IN |
属性のインデックス |
戻り値
(oratext *)
属性URI。
4.27 XmlEvGetAttrUriID()
XML_EVENT_START_ELEMENT
イベントに対する属性のURIの識別子を取得します。XmlEvCreatePPCtx()で指定されたユーザー定義のIDコールバックを起動します。コールバックが指定されていない場合、0
(ゼロ)を戻します。
構文
sb8 XmlEvGetAttrUriID( xmlevctx *evctx, ub4 index);
パラメータ | In/Out | 説明 |
---|---|---|
evctx |
IN |
XMLイベント・コンテキスト |
index |
IN |
属性のインデックス |
戻り値
(sb8)
識別子
4.28 XmlEvGetAttrValue()
XML_EVENT_START_ELEMENT
イベントのいずれかの属性値を取得し、イベントの長さをOUT len
パラメータとして戻します。
構文
oratext *XmlEvGetAttrValue( xmlevctx *evctx, ub4 index, ub4 *len);
パラメータ | In/Out | 説明 |
---|---|---|
evctx |
IN |
XMLイベント・コンテキスト |
index |
IN |
属性のインデックス |
len |
OUT |
イベント名の長さ |
戻り値
(oratext *)
属性値。
4.29 XmlEvGetAttrValue0()
XML_EVENT_START_ELEMENT
イベントのNULL
で終了する属性値を取得します。
構文
oratext *XmlEvGetAttrValue0( xmlevctx *evctx);
パラメータ | In/Out | 説明 |
---|---|---|
evctx |
IN |
XMLイベント・コンテキスト |
index |
IN |
属性のインデックス |
戻り値
(oratext *)
属性値。
4.30 XmlEvGetElDeclContent()
XML_EVENT_ELEMENT_DECLARATION
の要素宣言コンテンツを取得します。また、長さをOUT len
パラメータとして提供します。
構文
oratext *XmlEvGetElDeclContent( xmlevctx *evctx, ub4 *len);
パラメータ | In/Out | 説明 |
---|---|---|
evctx |
IN |
XMLイベント・コンテキスト |
len |
OUT |
長さ |
戻り値
(oratext *)
宣言コンテンツ。
4.31 XmlEvGetElDeclContent0()
XML_EVENT_ELEMENT_DECLARATION
の要素宣言コンテンツを取得します。
構文
oratext *XmlEvGetElDeclContent0( xmlevctx *evctx);
パラメータ | In/Out | 説明 |
---|---|---|
evctx |
IN |
XMLイベント・コンテキスト |
戻り値
(oratext *)
宣言コンテンツ。
4.32 XmlEvGetEncoding()
XmlEvCreatePPCtx()コールまたはXmlEvCreateSVCtx()コールで指定されたエンコーディングの値を戻します。
構文
oratext *XmlEvGetEncoding( xmlevctx *evctx);
パラメータ | In/Out | 説明 |
---|---|---|
evctx |
IN |
XMLイベント・コンテキスト |
戻り値
(oratext *)
出力エンコーディングのエンコーディング値。エンコーディングが指定されていない場合はNULL
を戻します。
4.33 XmlEvGetError()
XmlEvNext()コールによってXML_EVENT_FATAL_ERROR
またはXML_EVENT_ERROR
イベントが戻されるときにエラー番号を取得します。
構文
xmlerr XmlEvGetError( xmlevctx *evctx oratext **message);
パラメータ | In/Out | 説明 |
---|---|---|
evctx |
IN |
XMLイベント・コンテキスト |
message |
IN |
エラー・メッセージ |
戻り値
(xmlerr)
エラー番号。
4.34 XmlEvGetName()
イベントの名前を戻し、イベントの長さをOUT
len
パラメータで戻します。イベント名は、次のいずれかです。
-
XML_EVENT_START_ELEMENT
-
XML_EVENT_END_ELEMENT
-
XML_EVENT_START_ENTITY
-
XML_EVENT_ENTITY_REFERENCE
-
XML_EVENT_ELEMENT_DECLARATION
-
XML_EVENT_PE_DECLARATION
-
XML_EVENT_UE_DECLARATION
-
XML_EVENT_NOTATTION_DECLARATION
構文
oratext *XmlEvGetName( xmlevctx *evctx, ub4 *len);
パラメータ | In/Out | 説明 |
---|---|---|
evctx |
IN |
XMLイベント・コンテキスト |
len |
OUT |
名前の長さ |
戻り値
(oratext *)
名前
4.35 XmlEvGetName0()
次のいずれかのイベントのNULL
で終了する名前を取得します。
-
XML_EVENT_START_ELEMENT
-
XML_EVENT_END_ELEMENT
-
XML_EVENT_START_ENTITY
-
XML_EVENT_ENTITY_REFERENCE
-
XML_EVENT_ELEMENT_DECLARATION
-
XML_EVENT_PE_DECLARATION
-
XML_EVENT_UE_DECLARATION
-
XML_EVENT_NOTATTION_DECLARATION
構文
oratext *XmlEventGetName0( xmleventctx *evctx);
パラメータ | In/Out | 説明 |
---|---|---|
evctx |
IN |
XMLイベント・コンテキスト |
戻り値
(oratext *)
名前
4.36 XmlEvGetLocalName()
次のいずれかのイベントのローカル名タグを取得し、イベントの長さをOUT len
パラメータとして戻します。
-
XML_EVENT_START_ELEMENT
-
XML_EVENT_END_ELEMENT
構文
oratext *XmlEvGetLocalName( xmlevctx *evctx, ub4 *len);
パラメータ | In/Out | 説明 |
---|---|---|
evctx |
IN |
XMLイベント・コンテキスト |
len |
OUT |
イベント名の長さ |
戻り値
(oratext *)
ローカル名タグ。
4.37 XmlEvGetLocalName0()
次のいずれかのイベントのNULL
で終了するローカル名タグを取得します。
-
XML_EVENT_START_ELEMENT
-
XML_EVENT_END_ELEMENT
構文
oratext *XmlEvGetLocalName0( xmlevctx *evctx);
パラメータ | In/Out | 説明 |
---|---|---|
evctx |
IN |
XMLイベント・コンテキスト |
戻り値
(oratext *)
ローカル名タグ。
4.38 XmlEvGetLocation()
解析時の位置を入力ストリームおよびそのパスの行番号のOUT
パラメータとして取得します。解析プロセス中いつでも使用できます。
構文
void *XmlEvGetLocation( xmlevctx *evctx, ub4 *line, oratext **path);
パラメータ | In/Out | 説明 |
---|---|---|
evctx |
IN |
XMLイベント・コンテキスト |
line |
OUT |
行番号 |
path |
OUT |
URLまたはファイル名 |
4.39 XmlEvGetPIData()
次のいずれかのイベントのテキストを取得し、イベントの長さをOUT len
パラメータとして戻します。
-
XML_EVENT_PI
-
XML_EVENT_PI_CONT
構文
oratext *XmlEvGetPIData( xmlevctx *evctx ub4 *len);
パラメータ | In/Out | 説明 |
---|---|---|
evctx |
IN |
XMLイベント・コンテキスト |
len |
OUT |
イベント名の長さ |
戻り値
(oratext*)
data
4.40 XmlEvGetPIData0()
次のいずれかのイベントのNULL
で終了するデータを取得します。
-
XML_EVENT_PI
-
XML_EVENT_PI_CONT
構文
oratext *XmlEvGetPIData0( xmlevctx *evctx);
パラメータ | In/Out | 説明 |
---|---|---|
evctx |
IN |
XMLイベント・コンテキスト |
戻り値
(oratext *)
データ
4.41 XmlEvGetPITarget()
次のいずれかのイベントのターゲットを取得し、イベントの長さをOUT len
パラメータとして戻します。
-
XML_EVENT_PI
-
XML_EVENT_PI_CONT
構文
oratext *XmlEvGetPITarget( xmlevctx *evctx ub4 *len);
パラメータ | In/Out | 説明 |
---|---|---|
evctx |
IN |
XMLイベント・コンテキスト |
len |
OUT |
イベント名の長さ |
戻り値
(oratext *)
ターゲット
4.42 XmlEvGetPITarget0()
次のいずれかのイベントのNULL
で終了するターゲットを取得します。
-
XML_EVENT_PI
-
XML_EVENT_PI_CONT
構文
oratext *XmlEvGetPITarget0( xmlevctx *evctx);
パラメータ | In/Out | 説明 |
---|---|---|
evctx |
IN |
XMLイベント・コンテキスト |
戻り値
(oratext *)
ターゲット
4.43 XmlEvGetPEIsGen()
汎用エンティティが宣言されたかどうか(XML_EVENT_PE_DECLARATION
)を判別します。
構文
boolean XmlEvGetPEIsGen( xmlevctx *evctx);
パラメータ | In/Out | 説明 |
---|---|---|
evctx |
IN |
XMLイベント・コンテキスト |
戻り値
汎用エンティティの場合はTRUE
、パラメータの場合はFALSE
。
4.44 XmlEvGetPERepl()
PE宣言XML_EVENT_PE_DECLARATION
の置換テキストを取得します。また、長さをOUT len
パラメータとして提供します。
構文
oratext *XmlEvGetPERepl( xmlevctx *evctx, ub4 *len);
パラメータ | In/Out | 説明 |
---|---|---|
evctx |
IN |
XMLイベント・コンテキスト |
len |
OUT |
長さ |
戻り値
(oratext *)
PE置換テキスト。
4.45 XmlEvGetPERepl0()
PE宣言XML_EVENT_PE_DECLARATION
のNULL
で終了する置換テキストを取得します。
構文
oratext *XmlEvGetPERepl0( xmlevctx *evctx);
パラメータ | In/Out | 説明 |
---|---|---|
evctx |
IN |
XMLイベント・コンテキスト |
戻り値
(oratext *)
PE置換テキスト。
4.46 XmlEvGetPrefix()
次のいずれかのイベントの接頭辞タグを取得し、イベントの長さをOUT len
パラメータとして戻します。
-
XML_EVENT_START_ELEMENT
-
XML_EVENT_END_ELEMENT
構文
oratext *XmlEvGetPrefix( xmlevctx *evctx, ub4 *len);
パラメータ | In/Out | 説明 |
---|---|---|
evctx |
IN |
XMLイベント・コンテキスト |
len |
OUT |
接頭辞の長さ |
戻り値
(oratext *)
接頭辞タグ。
4.47 XmlEvGetPrefix0()
次のいずれかのイベントのNULL
で終了する接頭辞タグを取得します。
-
XML_EVENT_START_ELEMENT
-
XML_EVENT_END_ELEMENT
構文
oratext *XmlEvGetPrefix0( xmlevctx *evctx);
パラメータ | In/Out | 説明 |
---|---|---|
evctx |
IN |
XMLイベント・コンテキスト |
戻り値
(oratext *)
接頭辞タグ。
4.48 XmlEvGetPubId()
次のいずれかのイベントの公開識別子を取得し、長さをOUT len
パラメータとして提供します。
-
XML_EVENT_PE_DECLARATION
-
XML_EVENT_UE_DECLARATION
-
XML_EVENT_NOTATION_DECLARATION
構文
oratext *XmlEvGetPubId( xmlevctx *evctx, ub4 *len);
パラメータ | In/Out | 説明 |
---|---|---|
evctx |
IN |
XMLイベント・コンテキスト |
len |
OUT |
長さ |
戻り値
(oratext *)
公開識別子
4.49 XmlEvGetPubId0()
次のいずれかのイベントのNULL
で終了する公開識別子を取得します。
-
XML_EVENT_PE_DECLARATION
-
XML_EVENT_UE_DECLARATION
-
XML_EVENT_NOTATION_DECLARATION
構文
oratext *XmlEvGetPubId0( xmlevctx *evctx);
パラメータ | In/Out | 説明 |
---|---|---|
evctx |
IN |
XMLイベント・コンテキスト |
戻り値
(oratext *)
公開識別子
4.50 XmlEvGetSysId()
次のいずれかのイベントのシステム識別子を取得し、長さをOUT len
パラメータとして提供します。
-
XML_EVENT_PE_DECLARATION
-
XML_EVENT_UE_DECLARATION
-
XML_EVENT_NOTATION_DECLARATION
構文
oratext *XmlEvGetSysId( xmlevctx *evctx, ub4 *len);
パラメータ | In/Out | 説明 |
---|---|---|
evctx |
IN |
XMLイベント・コンテキスト |
len |
OUT |
長さ |
戻り値
(oratext *)
システム識別子
4.51 XmlEvGetSysId0()
次のいずれかのイベントのNULL
で終了するシステム識別子を取得します。
-
XML_EVENT_PE_DECLARATION
-
XML_EVENT_UE_DECLARATION
-
XML_EVENT_NOTATION_DECLARATION
構文
oratext *XmlEvGetSysId0( xmlevctx *evctx);
パラメータ | In/Out | 説明 |
---|---|---|
evctx |
IN |
XMLイベント・コンテキスト |
戻り値
(oratext *)
システム識別子
4.52 XmlEvGetTagID()
XML_EVENT_START_ELEMENT
イベントに対するタグのQNAME
の識別子を取得します。XmlEvCreatePPCtx()で指定されたユーザー定義のIDコールバックを起動します。コールバックが指定されていない場合、0
(ゼロ)を戻します。
構文
sb8 XmlEvGetTagID( xmlevctx *evctx)
パラメータ | In/Out | 説明 |
---|---|---|
evctx |
IN |
XMLイベント・コンテキスト |
戻り値
(sb8)
識別子
4.53 XmlEvGetTagUriID()
XML_EVENT_START_ELEMENT
またはXML_EVENT_END_ELEMENT
イベントに対するタグのURIの識別子を取得します。XmlEvCreatePPCtx()で指定されたユーザー定義のIDコールバックを起動します。コールバックが指定されていない場合、0
(ゼロ)を戻します。
構文
sb8 XmlEvGetTagUriID( xmlevctx *evctx)
パラメータ | In/Out | 説明 |
---|---|---|
evctx |
IN |
XMLイベント・コンテキスト |
戻り値
(sb8)
識別子
4.54 XmlEvGetText()
次のいずれかのイベントのテキストを取得し、イベントの長さをOUT len
パラメータとして戻します。
-
XML_EVENT_CHARACTERS
-
XML_EVENT_CHARACTERS_CONT
-
XML_EVENT_SPACE
-
XML_EVENT_SPACE_CONT
-
XML_EVENT_COMMENT
-
XML_EVENT_COMMENT_CONT
-
XML_EVENT_CDATA
-
XML_EVENT_CDATA_CONT
構文
oratext *XmlEvGetText( xmlevctx *evctx ub4 *len);
パラメータ | In/Out | 説明 |
---|---|---|
evctx |
IN |
XMLイベント・コンテキスト |
len |
OUT |
イベント名の長さ |
戻り値
(oratext *)
イベント・テキスト
4.55 XmlEvGetText0()
次のいずれかのイベントのNULL
で終了するテキストを取得します。
-
XML_EVENT_CHARACTERS
-
XML_EVENT_CHARACTERS_CONT
-
XML_EVENT_SPACE
-
XML_EVENT_SPACE_CONT
-
XML_EVENT_COMMENT
-
XML_EVENT_COMMENT_CONT
-
XML_EVENT_CDATA
-
XML_EVENT_CDATA_CONT
構文
oratext *XmlEvGetText0( xmlevctx *evctx);
パラメータ | In/Out | 説明 |
---|---|---|
evctx |
IN |
XMLイベント・コンテキスト |
戻り値
(oratext *)
イベント・テキスト
4.56 XmlEvGetUENdata()
XML_EVENT_UE_DECLARATION
イベントのndataを取得し、イベントの長さをOUT len
パラメータとして戻します。
構文
oratext *XmlEvGetUENdata( xmlevctx *evctx, ub4 *len);
パラメータ | In/Out | 説明 |
---|---|---|
evctx |
IN |
XMLイベント・コンテキスト |
len |
OUT |
イベント名の長さ |
戻り値
(oratext*)
ndata
4.57 XmlEvGetUENdata0()
XML_EVENT_UE_DECLARATION
イベントのNULL
で終了するndataを取得します。
構文
oratext *XmlEvGetUENdata0( xmlevctx *evctx);
パラメータ | In/Out | 説明 |
---|---|---|
evctx |
IN |
XMLイベント・コンテキスト |
戻り値
(oratext*)
ndata
4.58 XmlEvGetURI()
次のいずれかのイベントのURIタグを取得し、イベントの長さをOUT len
パラメータとして戻します。
-
XML_EVENT_START_ELEMENT
-
XML_EVENT_END_ELEMENT
構文
oratext *XmlEvGetURI( xmlevctx *evctx, ub4 *len);
パラメータ | In/Out | 説明 |
---|---|---|
evctx |
IN |
XMLイベント・コンテキスト |
len |
OUT |
イベント名の長さ |
戻り値
(oratext *)
URIタグ
4.59 XmlEvGetURI0()
次のいずれかのイベントのNULL
で終了するURIタグを取得します。
-
XML_EVENT_START_ELEMENT
-
XML_EVENT_END_ELEMENT
構文
oratext *XmlEvGetURI0( xmlevctx *evctx);
パラメータ | In/Out | 説明 |
---|---|---|
evctx |
IN |
XMLイベント・コンテキスト |
戻り値
(oratext *)
URIタグ
4.60 XmlEvGetVersion()
XML_EVENT_START_DOCUMENT
イベントのXML宣言でのバージョン仕様に関する情報を提供します。
構文
oratext *XmlEvGetVersion( xmlevctx *evctx);
パラメータ | In/Out | 説明 |
---|---|---|
evctx |
IN |
XMLイベント・コンテキスト |
戻り値
(oratext *)
XML宣言からのバージョン文字列。
4.61 XmlEvIsEncodingSpecified()
XML_EVENT_START_DOCUMENT
イベントのXML宣言でのエンコーディング仕様に関する情報を提供します。
構文
boolean XmlEvIsEncodingSpecified( xmlevctx *evctx);
パラメータ | In/Out | 説明 |
---|---|---|
evctx |
IN |
XMLイベント・コンテキスト |
戻り値
エンコーディングがXML宣言で指定されている場合はTRUE
、指定されていない場合はFALSE
を戻します。
4.62 XmlEvIsNamespaceAttr()
XML_EVENT_START_ELEMENT
イベントの属性が名前空間属性かどうかを判別します。
構文
boolean XmlEvIsNamespaceAttr( xmlevctx *evctx, ub4 index);
パラメータ | In/Out | 説明 |
---|---|---|
evctx |
IN |
XMLイベント・コンテキスト |
index |
IN |
属性のインデックス |
戻り値
属性が名前空間属性の場合はTRUE
、名前空間属性でない場合はFALSE
を戻します。
4.63 XmlEvIsStandalone()
XML_EVENT_START_DOCUMENT
イベントのXML宣言でのスタンドアロン仕様に関する情報を提供します。
構文
sword XmlEvIsStandalone( xmlevctx *evctx);
パラメータ | In/Out | 説明 |
---|---|---|
evctx |
IN |
XMLイベント・コンテキスト |
戻り値
(sword)
スタンドアロンがXML宣言で指定されていない場合は-1
、スタンドアロンにFALSE
が指定されている場合は0
、スタンドアロンにTRUE
が指定されている場合は1
を戻します
4.64 XmlEvNext()
次のイベントを取得し、パーサーを進めます。
構文
xmlevtype XmlEvNext( xmlevctx *evctx);
パラメータ | In/Out | 説明 |
---|---|---|
evctx |
IN |
XMLイベント・コンテキスト |
戻り値
(xmlevtype)
イベント
4.65 XmlEvNextTag()
XML_EVENT_START_ELEMENT
、XML_EVENT_END_ELEMENT
、XML_EVENT_END_DOCUMENT
などの次のタグ・イベントにパーサーを進めます。
構文
xmlevtype XmlEvNextTag( xmlevctx *evctx);
パラメータ | In/Out | 説明 |
---|---|---|
evctx |
IN |
XMLイベント・コンテキスト |
戻り値
(xmlevtype)
イベント
4.66 XmlEvLoadPPDoc()
新しいドキュメントをロードし、プル解析用に設定します。入力ソースからのXML文書をプル解析モードで解析する準備をします。入力ソースは、「C用のXML APIパッケージ」のXmlLoadDom()XmlLoadDom()およびXmlLoadSax()XmlLoadSax()のものと同じです。実際の解析は、XmlEvNext()への複数のコールによって進められます。
構文
xmlerr XmlEvLoadPPDoc( xmlctx *xctx, xmlevctx *evctx, oratext *inputType, void *input, ub4 inputLen, oratext *inputEncoding);
パラメータ | In/Out | 説明 |
---|---|---|
xctx |
IN |
XMLコンテキスト |
evctx |
IN |
XMLイベント・コンテキスト |
inputType |
IN |
入力タイプ(ファイル、バッファ、URI、ストリーム、stdioなど) |
input |
IN |
入力 |
inputLen |
IN |
バッファ入力タイプの入力の長さ |
inputEncoding |
IN |
入力エンコーディング |
戻り値
(xmlerr)
エラー・コード。
4.67 XmlEvSchemaValidate()
イベントによって表されるXML文書を検証します。ストリーム・バリデータを初期化します。
これは不透過メソッドです。かわりに透過的なXmlEvCreateSVCtx()XmlEvCreateSVCtx()およびXmlEvDestroySVCtx()XmlEvDestroySVCtx()を使用することもできます。
構文
xmlerr XmlEvSchemaValidate( xmlctx *xctx, xsdctx *sctx, xmlevctx *docEvCtx, oratext **errmsg);
パラメータ | In/Out | 説明 |
---|---|---|
xctx |
IN |
XMLコンテキスト |
sctx |
IN |
スキーマ・コンテキスト |
docEvCtx |
IN |
検証されるドキュメントのイベント・コンテキスト |
errmsg |
OUT |
エラー・コードに対応するエラー・メッセージ |
戻り値
(xmlerr)
エラー・コード。