cpiCreateContext

目的

パーサー・オブジェクトに関連付けられたユーザー定義拡張機能コンテキストを作成します。 これは、パーサー・オブジェクトのインスタンスが構成されるか、または割り振られる際に、メッセージ・ブローカーによって呼び出されます。 これは、メッセージ・フローによってメッセージ・データが解析されるときに発生します。 ブローカーがパーサー・オブジェクトを構成するかまたは割り振り、メッセージ・データの適切なセクションを獲得します。この関数が呼び出される前に、ブローカーは、パーサー用の有効なルート・エレメントとして名前エレメントを作成しています。 ただし、このエレメントには名前が付いていません。 パーサーは、このエレメントに cpiSetElementName 関数で名前を指定しなければなりません。

拡張機能は、以下の処理を担当します。
  1. 必要なパーサー・インスタンス固有のデータ域 (コンテキストなど) を割り振ります。
  2. 必要な任意の追加のリソースの獲得または初期化を実行します。
  3. コンテキストのアドレスを呼び出し関数に戻します。 このパーサー・インスタンスのインプリメンテーション関数が呼び出されるときにはいつでも、 適切なコンテキストがこの関数の引数として渡されます。これは、C で開発されるユーザー定義パーサーは、 インスタンスごとのデータ域を指す固有の静的ポインターを保守する必要がないことを意味します。
定義されている場所 タイプ メンバー
CPI_VFT 必須 iFpCreateContext

構文

void cpiCreateContext(
  CciParser*   parser);

パラメーター

parser
パーサー・オブジェクトのアドレス (入力)。

戻り値

成功した場合、ユーザー定義拡張機能コンテキストのアドレスが戻されます。 失敗した場合、ゼロの値が戻されます。

関連概念
ユーザー定義のパーサー
ユーザー定義拡張機能
関連資料
C パーサー・インプリメンテーション関数
特記事項 | 商標 | ダウンロード | ライブラリー | サポート | フィードバック
Copyright IBM Corporation 1999, 2006 最終更新: 08/21/2006
as08095_