4 C用のイベントAPIパッケージ

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

Eventインタフェース

Eventインタフェース

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

表4-1 Eventメソッドの概要

関数	概要
XmlEvCleanPPCtx()	解析操作に関連のある内部構造をクリーン・アップします。これにより、イベント・コンテキストは破棄されません。イベント・コンテキストは、このコールの後に再利用できます。
XmlEvCreatePPCtx()	イベント・コンテキストをプル解析モードで作成します。
XmlEvCreateSVCtx()	ストリーム・バリデータ用のイベント・コンテキストを作成します。
XmlEvDestroyPPCtx()	イベント・コンテキストを破棄します。解析を終了します。解析操作中いつでもコールできます。
XmlEvDestroySVCtx()	ストリーム・バリデータによって作成されたイベント・コンテキストを終了します。
XmlEvGetAttrCount()	`XML_EVENT_START_ELEMENT`イベントの属性数を取得します。
XmlEvGetAttrDeclBody()	属性宣言`XML_EVENT_ATTLIST_DECLARATION`の属性本体を取得します。また、長さを`OUT len`パラメータとして提供します。
XmlEvGetAttrDeclBody0()	属性宣言`XML_EVENT_ATTLIST_DECLARATION`の`NULL`で終了する属性本体を取得します。
XmlEvGetAttrDeclCount()	属性宣言`XML_EVENT_ATTLIST_DECLARATION`の属性数を取得します。
XmlEvGetAttrDeclElName()	属性宣言`XML_EVENT_ATTLIST_DECLARATION`の要素名を取得します。また、長さを`OUT len`パラメータとして提供します。
XmlEvGetAttrDeclElName0()	属性宣言`XML_EVENT_ATTLIST_DECLARATION`の`NULL`で終了する要素名を取得します。
XmlEvGetAttrDeclLocalName()	属性宣言`XML_EVENT_ATTLIST_DECLARATION`のローカル名を取得します。また、長さを`OUT len`パラメータとして提供します。
XmlEvGetAttrDeclLocalName0()	属性宣言`XML_EVENT_ATTLIST_DECLARATION`の`NULL`で終了するローカル名を取得します。
XmlEvGetAttrDeclName()	属性宣言`XML_EVENT_ATTLIST_DECLARATION`の属性名を取得します。また、長さを`OUT len`パラメータとして提供します。
XmlEvGetAttrDeclName0()	属性宣言`XML_EVENT_ATTLIST_DECLARATION`の`NULL`で終了する属性名を取得します。
XmlEvGetAttrDeclPrefix()	属性宣言`XML_EVENT_ATTLIST_DECLARATION`の属性接頭辞を取得します。また、長さを`OUT len`パラメータとして提供します。
XmlEvGetAttrDeclPrefix0()	属性宣言`XML_EVENT_ATTLIST_DECLARATION`の`NULL`で終了する属性接頭辞を取得します。
XmlEvGetAttrID()	`XML_EVENT_START_ELEMENT`イベントの、属性の`QNAME`の識別子を取得します。
XmlEvGetAttrLocalName()	`XML_EVENT_START_ELEMENT`イベントの属性ローカル名を取得します。また、長さを`OUT len`パラメータとして提供します。
XmlEvGetAttrLocalName0()	`XML_EVENT_START_ELEMENT`イベントの`NULL`で終了する属性名を取得します。
XmlEvGetAttrName()	`XML_EVENT_START_ELEMENT`イベントの属性名を取得します。また、長さを`OUT len`パラメータとして提供します。
XmlEvGetAttrName0()	`XML_EVENT_START_ELEMENT`イベントの`NULL`で終了する属性名を取得します。
XmlEvGetAttrPrefix()	`XML_EVENT_START_ELEMENT`イベントの接頭辞タグを取得し、イベントの長さを`OUT len`パラメータとして戻します。
XmlEvGetAttrPrefix0()	`XML_EVENT_START_ELEMENT`イベントの`NULL`で終了する属性接頭辞を取得します。
XmlEvGetAttrURI()	`XML_EVENT_START_ELEMENT`イベントの属性URIを取得します。また、長さを`OUT len`パラメータとして提供します。
XmlEvGetAttrURI0()	`XML_EVENT_START_ELEMENT`イベントの`NULL`で終了する属性URIを取得します。
XmlEvGetAttrUriID()	`XML_EVENT_START_ELEMENT`イベントに対する属性のURIの識別子を取得します。
XmlEvGetAttrValue()	`XML_EVENT_START_ELEMENT`イベントのいずれかの属性値を取得し、イベントの長さを`OUT len`パラメータとして戻します。
XmlEvGetAttrValue0()	`XML_EVENT_START_ELEMENT`イベントの`NULL`で終了する属性値を取得します。
XmlEvGetElDeclContent()	`XML_EVENT_ELEMENT_DECLARATION`の要素宣言コンテンツを取得します。また、長さを`OUT len`パラメータとして提供します。
XmlEvGetElDeclContent0()	`XML_EVENT_ELEMENT_DECLARATION`の要素宣言コンテンツを取得します。
XmlEvGetEncoding()	指定されたエンコーディングの値を戻します。
XmlEvGetError()	XmlEvNext()によって`XML_EVENT_FATAL_ERROR`または`XML_EVENT_ERROR`イベントが戻されるときにエラー番号を取得します。
XmlEvGetName()	`XML_EVENT_START_ELEMENT`または`XML_EVENT_END_ELEMENT`イベントの名前を戻し、イベントの長さを`OUT` `len`パラメータで戻します。
XmlEvGetName0()	`XML_EVENT_START_ELEMENT`または`XML_EVENT_END_ELEMENT`イベントの`NULL`で終了する名前を取得します。
XmlEvGetLocalName()	`XML_EVENT_START_ELEMENT`または`XML_EVENT_END_ELEMENT`イベントのローカル名タグを取得し、イベントの長さを`OUT len`パラメータとして戻します。
XmlEvGetLocalName0()	`XML_EVENT_START_ELEMENT`または`XML_EVENT_END_ELEMENT`イベントの`NULL`で終了するローカル名タグを取得し、イベントの長さを`OUT len`パラメータとして戻します。
XmlEvGetLocation()	解析時の位置を入力ストリームおよびそのパスの行番号の`OUT`パラメータとして取得します。
XmlEvGetPIData()	`XML_EVENT_PI`または`XML_EVENT_PI_CONT`イベントのテキストを取得し、イベントの長さを`OUT len`パラメータとして戻します。
XmlEvGetPIData0()	`XML_EVENT_PI`または`XML_EVENT_PI_CONT`イベントの`NULL`で終了するテキストを取得します。
XmlEvGetPITarget()	`XML_EVENT_PI`および`XML_EVENT_PI_CONT`イベントのターゲットを取得し、イベントの長さを`OUT len`パラメータとして戻します。
XmlEvGetPITarget0()	`XML_EVENT_PI`および`XML_EVENT_PI_CONT`イベントの`NULL`で終了するターゲットを取得します。
XmlEvGetPEIsGen()	汎用エンティティが宣言されたかどうか（`XML_EVENT_PE_DECLARATION`）を判別します。
XmlEvGetPERepl()	PE宣言`XML_EVENT_PE_DECLARATION`の置換テキストを取得します。また、長さを`OUT len`パラメータとして提供します。
XmlEvGetPERepl0()	PE宣言`XML_EVENT_PE_DECLARATION`の`NULL`で終了する置換テキストを取得します。
XmlEvGetPrefix()	`XML_EVENT_START_ELEMENT`または`XML_EVENT_END_ELEMENT`イベントのいずれかの接頭辞タグを取得し、イベントの長さを`OUT len`パラメータとして戻します。
XmlEvGetPrefix0()	`XML_EVENT_START_ELEMENT`または`XML_EVENT_END_ELEMENT`イベントのいずれかの接頭辞タグを取得します。
XmlEvGetPubId()	`XML_EVENT_PE_DECLARATION`、`XML_EVENT_UE_DECLARATION`または`XML_EVENT_NOTATION_DECLARATION`イベントの公開識別子を取得し、長さを`OUT len`パラメータとして戻します。
XmlEvGetPubId0()	`XML_EVENT_PE_DECLARATION`、`XML_EVENT_UE_DECLARATION`または`XML_EVENT_NOTATION_DECLARATION`イベントの`NULL`で終了する公開識別子を取得します。
XmlEvGetSysId()	`XML_EVENT_PE_DECLARATION`、`XML_EVENT_UE_DECLARATION`または`XML_EVENT_NOTATION_DECLARATION`イベントのシステム識別子を取得し、長さを`OUT len`パラメータとして戻します。
XmlEvGetSysId0()	`XML_EVENT_PE_DECLARATION`、`XML_EVENT_UE_DECLARATION`または`XML_EVENT_NOTATION_DECLARATION`イベントの`NULL`で終了するシステム識別子を取得します。
XmlEvGetTagID()	`XML_EVENT_START_ELEMENT`イベントに対するタグの`QNAME`の識別子を取得します。
XmlEvGetTagUriID()	`XML_EVENT_START_ELEMENT`または`XML_EVENT_END_ELEMENT`イベントに対するタグのURIの識別子を取得します。
XmlEvGetText()	`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`イベントのテキストを取得し、イベントの長さを`OUT len`パラメータとして戻します。
XmlEvGetText0()	`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`イベントの`NULL`で終了するテキストを取得します。
XmlEvGetUENdata()	`XML_EVENT_UE_DECLARATION`イベントのndataを取得し、イベントの長さを`OUT len`パラメータとして戻します。
XmlEvGetUENdata0()	`XML_EVENT_UE_DECLARATION`イベントの`NULL`で終了するndataを取得します。
XmlEvGetURI()	`XML_EVENT_START_ELEMENT`または`XML_EVENT_END_ELEMENT`イベントのURIタグを取得し、イベントの長さを`OUT len`パラメータとして戻します。
XmlEvGetURI0()	`XML_EVENT_START_ELEMENT`または`XML_EVENT_END_ELEMENT`イベントの`NULL`で終了するURIタグを取得します。
XmlEvGetVersion()	`XML_EVENT_START_DOCUMENT`イベントのXML宣言でのバージョン仕様に関する情報を提供します。
XmlEvIsEncodingSpecified()	`XML_EVENT_START_DOCUMENT`イベントのXML宣言でのエンコーディング仕様に関する情報を提供します。
XmlEvIsNamespaceAttr()	`XML_EVENT_START_ELEMENT`イベントの属性が名前空間属性かどうかを判別します。
XmlEvIsStandalone()	`XML_EVENT_START_DOCUMENT`イベントのXML宣言でのスタンドアロン仕様に関する情報を提供します。
XmlEvNext()	次のイベントを取得し、パーサーを進めます。
XmlEvNextTag()	パーサーを次のタグ・イベントに進めます。
XmlEvLoadPPDoc()	新しいドキュメントをロードし、プル解析用に構成します。
XmlEvSchemaValidate()	イベントによって表されるXML文書を検証します。

XmlEvCleanPPCtx()

解析操作に関連のある内部構造をクリーン・アップします。これにより、イベント・コンテキストは破棄されません。イベント・コンテキストは、このコールの後に再利用できます。

構文

xmlerr XmlEvCleanPPCtx(
   xmlctx *xctx,
   xmlevctx *evctx);

パラメータ	IN/OUT	説明
xctx	IN	XMLコンテキスト
evtx	IN	XmlEventsコンテキスト

戻り値

(xmlerr) エラー番号。

XmlEvCreatePPCtx()

イベント・コンテキストをプル解析モードで作成します。

XmlEvLoadPPDocを使用してドキュメントがロードされます。実際の解析は、XmlEvNext()への複数のコールによって進められます。各コールの後に、様々なXmlEvGetXXX()関数へのコールによって関連情報が取得される場合があります。プロパティの基本セットは、XmlLoadDomと同じです。入力ソースは、XmlEvLoadPPDoc()コールで指定される必要があります。

構文

xmlevctx *XmlEvCreatePPCtx(
   xmlctx *xctx,
   xmlerr  *xerr,
   list);

パラメータ IN/OUT 説明

xctx

IN

XMLコンテキスト

xerr

IN

数値のエラー・コード。正常に終了した場合は、XMLERR_OK [0]を戻します。

list

IN

これらの追加プロパティは、NULLで終了する必要があります。

("expand_entities", boolean)つまり、FALSEの場合、解析される非パラメータ実体参照は拡張されません。デフォルトでは、それらの参照が拡張されます。
("use_buffer", buffer)はバッファのアドレスで、指定時にそのバッファを使用して、ユーザーに戻す必要があるデータを収集します。getXXX()関数はこのバッファをデータ・ポインタとして戻します。
("use_buffer_len", lengthOfBuffer)は、バッファ内のバイト数で、バッファの実際の長さであり、指定された長さを超えて収集されることはありません。バッファを超える場合は、データの一部のみが収集され、イベントのCONTフレーバが生成されます。XmlEventsNextへの後続のコールによって追加データが提供されます。CONTフレーバ・イベントのシーケンスは、常に非CONTイベントによって終了します。バッファは、一部のみが満たされる場合があります。
("get_id_callback", function)は、テキストベース名を8バイト識別子に変換するためのコールバック関数のアドレスです。この関数が提供されると、ユーザーは、XmlEvGetTagID、XmlEvGetAttrID、XmlEvGetTagUriIDおよびXmlEvGetAttrUriIDを使用できるようになります。
("raw_buffer_len", length)は、バッファ内のバイト数です。デフォルトでは、このパラメータは256Kです。入力データの読込み、文字変換、およびCRLFとCRのLFへの変換にはRAWバッファが使用されます。
("error_callback", callback)は、そのイベントのAPIの不正使用を示すために呼び出されるコールバック関数のアドレスを指定します。

これらのオプション・パラメータは、次のように使用してください。

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()への後続コールに渡されるイベント・コンテキスト。

XmlEvCreateSVCtx()

ストリーム・バリデータ用のイベント・コンテキストを作成します。ストリーム・バリデータを初期化し、後続のコールで使用できるイベント・コンテキストを戻します。

XmlEvDestroySVCtx()とともに使用します。これは透過的なメソッドです。かわりに不透過なXmlEvSchemaValidate()を使用することもできます。

構文

xmlevctx *XmlEvCreateSVCtx(
   xmlctx *xctx,
   xsdctx *sctx,
   xmlevctx *docEvCtx,
   xmlerr *err);

パラメータ	IN/OUT	説明
xctx	IN	XMLコンテキスト。有効である必要があります。
sctx	IN	スキーマ・コンテキスト。有効である必要があります。
docEvCtx	IN	検証されるドキュメントのイベント・コンテキスト
err	OUT	数値のエラー・コード。正常に終了した場合は、`XMLERR_OK [0]`を戻します。

戻り値

(xmlevctx) XmlEvNext()への後続コールに渡されるイベント・コンテキスト。

XmlEvDestroyPPCtx()

イベント・コンテキストを破棄します。解析を終了します。解析操作中いつでもコールできます。

構文

void XmlEvDestroyPPCtx(
   xmlevctx *evctx);

パラメータ	IN/OUT	説明
evctx	IN	XMLイベント・コンテキスト

XmlEvDestroySVCtx()

ストリーム・バリデータによって作成されたイベント・コンテキストを終了します。正常に終了した場合は、XMLERR_OK [0]を戻し、失敗時には数値のエラー・コードを戻します。

XmlEvCreateSVCtx()とともに使用します。これは透過的なメソッドです。かわりに不透過なXmlEvSchemaValidate()を使用することもできます。

構文

xmlerr XmlEvDestroySVCtx(
   xmlctx *xctx,
   xmlevctx *evCtx);

パラメータ	IN/OUT	説明
xctx	IN	XMLコンテキスト
evCtx	IN	終了されたイベント・コンテキスト

戻り値

(xmlerr) エラー番号。

XmlEvGetAttrCount()

XML_EVENT_START_ELEMENTイベントの属性数を取得します。

構文

ub4  XmlEvGetAttrCount(
   xmlevctx *evctx);

パラメータ	IN/OUT	説明
evctx	IN	XMLイベント・コンテキスト

戻り値

(ub4) 属性数。

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 *) 宣言本体。

XmlEvGetAttrDeclBody0()

属性宣言XML_EVENT_ATTLIST_DECLARATIONのNULLで終了する属性本体を取得します。

構文

oratext *XmlEvGetAttrDeclBody0(
   xmlevctx *evctx,
   ub4 index);

パラメータ	IN/OUT	説明
evctx	IN	XMLイベント・コンテキスト
index	IN	属性のインデックス

戻り値

(oratext *) 宣言本体。

XmlEvGetAttrDeclCount()

属性宣言XML_EVENT_ATTLIST_DECLARATIONの属性数を取得します。

構文

ub4 XmlEvGetAttrDeclCount(
   xmlevctx *evctx);

パラメータ	IN/OUT	説明
evctx	IN	XMLイベント・コンテキスト

戻り値

(ub4) 属性数。

XmlEvGetAttrDeclElName()

属性宣言XML_EVENT_ATTLIST_DECLARATIONの要素名を取得します。また、長さをOUT lenパラメータとして提供します。

構文

oratext *XmlEvGetAttrDeclElName(
   xmlevctx *evctx,
   ub4 *len);

パラメータ	IN/OUT	説明
evctx	IN	XMLイベント・コンテキスト
len	OUT	長さ

戻り値

(oratext *) 要素名。

XmlEvGetAttrDeclElName0()

属性宣言XML_EVENT_ATTLIST_DECLARATIONのNULLで終了する要素名を取得します。

構文

oratext *XmlEvGetAttrDeclElName0(
   xmlevctx *evctx);

パラメータ	IN/OUT	説明
evctx	IN	XMLイベント・コンテキスト

戻り値

(oratext *) 要素名。

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 *) ローカル名。

XmlEvGetAttrDeclLocalName0()

属性宣言イベントXML_EVENT_ATTLIST_DECLARATIONのNULLで終了するローカル名を取得します。

構文

oratext *XmlEvGetAttrDeclLocalName0(
   xmlevctx *evctx,
   ub4 index);

パラメータ	IN/OUT	説明
evctx	IN	XMLイベント・コンテキスト
index	IN	属性のインデックス

戻り値

(oratext *) ローカル名。

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 *) 属性名。

XmlEvGetAttrDeclName0()

属性宣言XML_EVENT_ATTLIST_DECLARATIONのNULLで終了する属性名を取得します。

構文

oratext *XmlEvGetAttrDeclName0(
   xmlevctx *evctx,
   ub4 index);

パラメータ	IN/OUT	説明
evctx	IN	XMLイベント・コンテキスト
index	IN	属性のインデックス

戻り値

(oratext *) 属性名。

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 *) 属性接頭辞。

XmlEvGetAttrDeclPrefix0()

属性宣言XML_EVENT_ATTLIST_DECLARATIONのNULLで終了する属性接頭辞を取得します。

構文

oratext *XmlEvGetAttrDeclPrefix0(
   xmlevctx *evctx,
   ub4 index);

パラメータ	IN/OUT	説明
evctx	IN	XMLイベント・コンテキスト
index	IN	属性のインデックス

戻り値

(oratext *) 属性接頭辞。

XmlEvGetAttrID()

XML_EVENT_START_ELEMENTイベントの、属性のQNAMEの識別子を取得します。XmlEvCreatePPCtx()で指定されたユーザー定義のIDコールバックを起動します。コールバックが指定されていない場合、0（ゼロ）を戻します。

構文

sb8 XmlEvGetAttrID(
   xmlevctx *evctx
   ub4 index);

パラメータ	IN/OUT	説明
evctx	IN	XMLイベント・コンテキスト
index	IN	属性のインデックス

戻り値

(sb8) 識別子。

XmlEvGetAttrLocalName()

XML_EVENT_START_ELEMENTイベントの属性ローカル名を取得します。また、長さをOUT lenパラメータとして提供します。

構文

oratext *XmlEvGetAttrLocalName(
   xmlevctx *evctx,
   ub4 index
   ub4 *len);

パラメータ	IN/OUT	説明
evctx	IN	XMLイベント・コンテキスト
index	IN	属性のインデックス。`XML_EVENT_START_ATTR`の場合は無視されます。
len	OUT	長さ

戻り値

(oratext *) 属性名。

XmlEvGetAttrLocalName0()

XML_EVENT_START_ELEMENTイベントのNULLで終了する属性ローカル名を取得します。

構文

oratext *XmlEvGetAttrLocalName0(
   xmlevctx *evctx,
   ub4 index);

パラメータ	IN/OUT	説明
evctx	IN	XMLイベント・コンテキスト
index	IN	属性のインデックス。`XML_EVENT_START_ATTR`の場合は無視されます。

戻り値

(oratext *) 属性名。

XmlEvGetAttrName()

XML_EVENT_START_ELEMENTイベントの属性名を取得します。また、長さをOUT lenパラメータとして提供します。

構文

oratext *XmlEvGetAttrName(
   xmlevctx *evctx,
   ub4 index
   ub4 *len);

パラメータ	IN/OUT	説明
evctx	IN	XMLイベント・コンテキスト
index	IN	属性のインデックス。`XML_EVENT_START_ATTR`の場合は無視されます。
len	OUT	長さ

戻り値

(oratext *) 属性名。

XmlEvGetAttrName0()

XML_EVENT_START_ELEMENTイベントのNULLで終了する属性名を取得します。

構文

oratext *XmlEvGetAttrName0(
   xmlevctx *evctx,
   ub4 index);

パラメータ	IN/OUT	説明
evctx	IN	XMLイベント・コンテキスト
index	IN	属性のインデックス。`XML_EVENT_START_ATTR`の場合は無視されます。

戻り値

(oratext *) 属性名。

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 *) 属性接頭辞。

XmlEvGetAttrPrefix0()

XML_EVENT_START_ELEMENTイベントのNULLで終了する属性接頭辞を取得します。

構文

oratext *XmlEvGetAttrPrefix0(
   xmlevctx *evctx);

パラメータ	IN/OUT	説明
evctx	IN	XMLイベント・コンテキスト
index	IN	属性のインデックス

戻り値

(oratext *) 属性接頭辞。

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。

XmlEvGetAttrURI0()

XML_EVENT_START_ELEMENTイベントのNULLで終了する属性URIを取得します。

構文

oratext *XmlEvGetAttrURI0(
   xmlevctx *evctx,
   ub4 index);

パラメータ	IN/OUT	説明
evctx	IN	XMLイベント・コンテキスト
index	IN	属性のインデックス

戻り値

(oratext *) 属性URI。

XmlEvGetAttrUriID()

XML_EVENT_START_ELEMENTイベントに対する属性のURIの識別子を取得します。XmlEvCreatePPCtx()で指定されたユーザー定義のIDコールバックを起動します。コールバックが指定されていない場合、0（ゼロ）を戻します。

構文

sb8 XmlEvGetAttrUriID(
   xmlevctx *evctx,
   ub4 index);

パラメータ	IN/OUT	説明
evctx	IN	XMLイベント・コンテキスト
index	IN	属性のインデックス

戻り値

(sb8) 識別子。

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 *) 属性値。

XmlEvGetAttrValue0()

XML_EVENT_START_ELEMENTイベントのNULLで終了する属性値を取得します。

構文

oratext *XmlEvGetAttrValue0(
   xmlevctx *evctx);

パラメータ	IN/OUT	説明
evctx	IN	XMLイベント・コンテキスト
index	IN	属性のインデックス

戻り値

(oratext *) 属性値。

XmlEvGetElDeclContent()

XML_EVENT_ELEMENT_DECLARATIONの要素宣言コンテンツを取得します。また、長さをOUT lenパラメータとして提供します。

構文

oratext *XmlEvGetElDeclContent(
   xmlevctx *evctx,
   ub4 *len);

パラメータ	IN/OUT	説明
evctx	IN	XMLイベント・コンテキスト
len	OUT	長さ

戻り値

(oratext *) 宣言コンテンツ。

XmlEvGetElDeclContent0()

XML_EVENT_ELEMENT_DECLARATIONの要素宣言コンテンツを取得します。

構文

oratext *XmlEvGetElDeclContent0(
   xmlevctx *evctx);

パラメータ	IN/OUT	説明
evctx	IN	XMLイベント・コンテキスト

戻り値

(oratext *) 宣言コンテンツ。

XmlEvGetEncoding()

XmlEvCreatePPCtx()コールまたはXmlEvCreateSVCtx()コールで指定されたエンコーディングの値を戻します。

構文

oratext *XmlEvGetEncoding(
   xmlevctx *evctx);

パラメータ	IN/OUT	説明
evctx	IN	XMLイベント・コンテキスト

戻り値

(oratext *) 出力エンコーディングのエンコーディング値。エンコーディングが指定されていない場合はNULLを戻します。

XmlEvGetError()

XmlEvNext()コールによってXML_EVENT_FATAL_ERRORまたはXML_EVENT_ERRORイベントが戻されるときにエラー番号を取得します。

構文

xmlerr XmlEvGetError(
   xmlevctx *evctx
   oratext **message);

パラメータ	IN/OUT	説明
evctx	IN	XMLイベント・コンテキスト
message	IN	エラー・メッセージ

戻り値

(xmlerr) エラー番号。

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 *) 名前。

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 *) 名前。

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 *) ローカル名タグ。

XmlEvGetLocalName0()

次のいずれかのイベントのNULLで終了するローカル名タグを取得します。

XML_EVENT_START_ELEMENT
XML_EVENT_END_ELEMENT

構文

oratext *XmlEvGetLocalName0(
   xmlevctx *evctx);

パラメータ	IN/OUT	説明
evctx	IN	XMLイベント・コンテキスト

戻り値

(oratext *) ローカル名タグ。

XmlEvGetLocation()

解析時の位置を入力ストリームおよびそのパスの行番号のOUTパラメータとして取得します。解析プロセス中いつでも使用できます。

構文

void *XmlEvGetLocation(
   xmlevctx *evctx,
   ub4 *line,
   oratext **path);

パラメータ	IN/OUT	説明
evctx	IN	XMLイベント・コンテキスト
line	OUT	行番号
path	OUT	URLまたはファイル名

XmlEvGetPIData()

次のいずれかのイベントのテキストを取得し、イベントの長さをOUT lenパラメータとして戻します。

XML_EVENT_PI
XML_EVENT_PI_CONT

構文

oratext *XmlEvGetPIData(
   xmlevctx *evctx
   ub4 *len);

パラメータ	IN/OUT	説明
evctx	IN	XMLイベント・コンテキスト
len	OUT	イベント名の長さ

戻り値

(oratext *) データ。

XmlEvGetPIData0()

次のいずれかのイベントのNULLで終了するデータを取得します。

XML_EVENT_PI
XML_EVENT_PI_CONT

構文

oratext *XmlEvGetPIData0(
   xmlevctx *evctx);

パラメータ	IN/OUT	説明
evctx	IN	XMLイベント・コンテキスト

戻り値

(oratext *) データ。

XmlEvGetPITarget()

次のいずれかのイベントのターゲットを取得し、イベントの長さをOUT lenパラメータとして戻します。

XML_EVENT_PI
XML_EVENT_PI_CONT

構文

oratext *XmlEvGetPITarget(
   xmlevctx *evctx
   ub4 *len);

パラメータ	IN/OUT	説明
evctx	IN	XMLイベント・コンテキスト
len	OUT	イベント名の長さ

戻り値

(oratext *) ターゲット。

XmlEvGetPITarget0()

次のいずれかのイベントのNULLで終了するターゲットを取得します。

XML_EVENT_PI
XML_EVENT_PI_CONT

構文

oratext *XmlEvGetPITarget0(
   xmlevctx *evctx);

パラメータ	IN/OUT	説明
evctx	IN	XMLイベント・コンテキスト

戻り値

(oratext *) ターゲット。

XmlEvGetPEIsGen()

汎用エンティティが宣言されたかどうか（XML_EVENT_PE_DECLARATION）を判別します。

構文

boolean XmlEvGetPEIsGen(
   xmlevctx *evctx);

パラメータ	IN/OUT	説明
evctx	IN	XMLイベント・コンテキスト

戻り値

汎用エンティティの場合はTRUE、パラメータの場合はFALSE。

XmlEvGetPERepl()

PE宣言XML_EVENT_PE_DECLARATIONの置換テキストを取得します。また、長さをOUT lenパラメータとして提供します。

構文

oratext *XmlEvGetPERepl(
   xmlevctx *evctx,
   ub4 *len);

パラメータ	IN/OUT	説明
evctx	IN	XMLイベント・コンテキスト
len	OUT	長さ

戻り値

(oratext *) PE置換テキスト。

XmlEvGetPERepl0()

PE宣言XML_EVENT_PE_DECLARATIONのNULLで終了する置換テキストを取得します。

構文

oratext *XmlEvGetPERepl0(
   xmlevctx *evctx);

パラメータ	IN/OUT	説明
evctx	IN	XMLイベント・コンテキスト

戻り値

(oratext *) PE置換テキスト。

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 *) 接頭辞タグ。

XmlEvGetPrefix0()

次のいずれかのイベントのNULLで終了する接頭辞タグを取得します。

XML_EVENT_START_ELEMENT
XML_EVENT_END_ELEMENT

構文

oratext *XmlEvGetPrefix0(
   xmlevctx *evctx);

パラメータ	IN/OUT	説明
evctx	IN	XMLイベント・コンテキスト

戻り値

(oratext *) 接頭辞タグ。

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 *) 公開識別子。

XmlEvGetPubId0()

次のいずれかのイベントのNULLで終了する公開識別子を取得します。

XML_EVENT_PE_DECLARATION
XML_EVENT_UE_DECLARATION
XML_EVENT_NOTATION_DECLARATION

構文

oratext *XmlEvGetPubId0(
   xmlevctx *evctx);

パラメータ	IN/OUT	説明
evctx	IN	XMLイベント・コンテキスト

戻り値

(oratext *) 公開識別子。

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 *) システム識別子。

XmlEvGetSysId0()

次のいずれかのイベントのNULLで終了するシステム識別子を取得します。

XML_EVENT_PE_DECLARATION
XML_EVENT_UE_DECLARATION
XML_EVENT_NOTATION_DECLARATION

構文

oratext *XmlEvGetSysId0(
   xmlevctx *evctx);

パラメータ	IN/OUT	説明
evctx	IN	XMLイベント・コンテキスト

戻り値

(oratext *) システム識別子。

XmlEvGetTagID()

XML_EVENT_START_ELEMENTイベントに対するタグのQNAMEの識別子を取得します。XmlEvCreatePPCtx()で指定されたユーザー定義のIDコールバックを起動します。コールバックが指定されていない場合、0（ゼロ）を戻します。

構文

sb8 XmlEvGetTagID(
   xmlevctx *evctx)

パラメータ	IN/OUT	説明
evctx	IN	XMLイベント・コンテキスト

戻り値

(sb8) 識別子。

XmlEvGetTagUriID()

XML_EVENT_START_ELEMENTまたはXML_EVENT_END_ELEMENTイベントに対するタグのURIの識別子を取得します。XmlEvCreatePPCtx()で指定されたユーザー定義のIDコールバックを起動します。コールバックが指定されていない場合、0（ゼロ）を戻します。

構文

sb8 XmlEvGetTagUriID(
   xmlevctx *evctx)

パラメータ	IN/OUT	説明
evctx	IN	XMLイベント・コンテキスト

戻り値

(sb8) 識別子。

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 *) イベント・テキスト。

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 *) イベント・テキスト。

XmlEvGetUENdata()

XML_EVENT_UE_DECLARATIONイベントのndataを取得し、イベントの長さをOUT lenパラメータとして戻します。

構文

oratext *XmlEvGetUENdata(
   xmlevctx *evctx,
   ub4 *len);

パラメータ	IN/OUT	説明
evctx	IN	XMLイベント・コンテキスト
len	OUT	イベント名の長さ

戻り値

(oratext*) ndata。

XmlEvGetUENdata0()

XML_EVENT_UE_DECLARATIONイベントのNULLで終了するndataを取得します。

構文

oratext *XmlEvGetUENdata0(
   xmlevctx *evctx);

パラメータ	IN/OUT	説明
evctx	IN	XMLイベント・コンテキスト

戻り値

(oratext*) ndata。

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タグ。

XmlEvGetURI0()

次のいずれかのイベントのNULLで終了するURIタグを取得します。

XML_EVENT_START_ELEMENT
XML_EVENT_END_ELEMENT

構文

oratext *XmlEvGetURI0(
   xmlevctx *evctx);

パラメータ	IN/OUT	説明
evctx	IN	XMLイベント・コンテキスト

戻り値

(oratext *) URIタグ。

XmlEvGetVersion()

XML_EVENT_START_DOCUMENTイベントのXML宣言でのバージョン仕様に関する情報を提供します。

構文

oratext *XmlEvGetVersion(
   xmlevctx *evctx);

パラメータ	IN/OUT	説明
evctx	IN	XMLイベント・コンテキスト

戻り値

(oratext *) XML宣言からのバージョン文字列。

XmlEvIsEncodingSpecified()

XML_EVENT_START_DOCUMENTイベントのXML宣言でのエンコーディング仕様に関する情報を提供します。

構文

boolean XmlEvIsEncodingSpecified(
   xmlevctx *evctx);

パラメータ	IN/OUT	説明
evctx	IN	XMLイベント・コンテキスト

戻り値

エンコーディングがXML宣言で指定されている場合はTRUE、指定されていない場合はFALSEを戻します。

XmlEvIsNamespaceAttr()

XML_EVENT_START_ELEMENTイベントの属性が名前空間属性かどうかを判別します。

構文

boolean XmlEvIsNamespaceAttr(
   xmlevctx *evctx,
   ub4 index);

パラメータ	IN/OUT	説明
evctx	IN	XMLイベント・コンテキスト
index	IN	属性のインデックス

戻り値

属性が名前空間属性の場合はTRUE、名前空間属性でない場合はFALSEを戻します。

XmlEvIsStandalone()

XML_EVENT_START_DOCUMENTイベントのXML宣言でのスタンドアロン仕様に関する情報を提供します。

構文

sword  XmlEvIsStandalone(
   xmlevctx *evctx);

パラメータ	IN/OUT	説明
evctx	IN	XMLイベント・コンテキスト

戻り値

(sword) スタンドアロンがXML宣言で指定されていない場合は-1、スタンドアロンにFALSEが指定されている場合は0、スタンドアロンにTRUEが指定されている場合は1を戻します。

XmlEvNext()

次のイベントを取得し、パーサーを進めます。

構文

xmlevtype XmlEvNext(
   xmlevctx *evctx);

パラメータ	IN/OUT	説明
evctx	IN	XMLイベント・コンテキスト

戻り値

(xmlevtype) イベント。

XmlEvNextTag()

XML_EVENT_START_ELEMENT、XML_EVENT_END_ELEMENT、XML_EVENT_END_DOCUMENTなどの次のタグ・イベントにパーサーを進めます。

構文

xmlevtype XmlEvNextTag(
   xmlevctx *evctx);

パラメータ	IN/OUT	説明
evctx	IN	XMLイベント・コンテキスト

戻り値

(xmlevtype) イベント。

XmlEvLoadPPDoc()

新しいドキュメントをロードし、プル解析用に設定します。入力ソースからのXML文書をプル解析モードで解析する準備をします。入力ソースは、第10章「C用のXML APIパッケージ」のXmlLoadDom()および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) エラー・コード。

XmlEvSchemaValidate()

イベントによって表されるXML文書を検証します。ストリーム・バリデータを初期化します。

これは不透過メソッドです。かわりに透過的なXmlEvCreateSVCtx()およびXmlEvDestroySVCtx()を使用することもできます。

構文

xmlerr XmlEvSchemaValidate(
   xmlctx *xctx,
   xsdctx *sctx,
   xmlevctx *docEvCtx,
   oratext **errmsg);

パラメータ	IN/OUT	説明
xctx	IN	XMLコンテキスト
sctx	IN	スキーマ・コンテキスト
docEvCtx	IN	検証されるドキュメントのイベント・コンテキスト
errmsg	OUT	エラー・コードに対応するエラー・メッセージ

戻り値

(xmlerr) エラー・コード。