cpiWriteBufferEncoded

目的

この関数は、既存の cpiWriteBuffer() インプリメンテーション関数によって提供される機能の拡張で、 パーサーがエレメント・ツリーを出力ビット・ストリームに直列化する際に、 出力メッセージを表すために使用されるエンコードおよびコード化文字セットを提供します。 直列化が必要ない場合 (たとえば、出力ベースが入力ビット・ストリームに基づく場合や、 ツリーが変更されていない場合)、ブローカーはこのインプリメンテーション関数を呼び出しません。 このインプリメンテーション関数が CPI_VFT 構造で提供されている場合、cpiWriteBuffer() または cpiWriteBufferFormatted() のどちらも指定できません。 指定した場合、cpiDefineParserClass() 関数は失敗し、 戻りコード CCI_INVALID_IMPL_FUNCTION が出されます。

定義されている場所 タイプ メンバー
CPI_VFT 条件付き iFpWriteBufferEncoded

構文

int cpiWriteBufferEncoded(
  CciParser*     parser,
  CciContext*    context,
  int            encoding,
  int            ccsid); 

パラメーター

parser
パーサー・オブジェクトのアドレス (入力)。
context
プラグイン・コンテキストのアドレス (入力)。
encoding
メッセージ・バッファーのエンコード (入力)。
ccsid
メッセージ・バッファーの ccsid (入力)。

戻り値

バッファーでビット・ストリームに追加されるデータのサイズ (バイト数)。

サンプル

この例は、サンプル・パーサー・ファイル BipSampPluginParser.c から取られています (612 行から 642 行)。

int cpiWriteBufferEncoded(
  CciParser*     parser,
  CciContext*    context,
  int            encoding,
  int         ccsid
){
  PARSER_CONTEXT_ST* pc = (PARSER_CONTEXT_ST *)context ;
  int                initialSize = 0;
  int                rc = 0;
  const void* a;
  CciByte b;

  
  initialSize = cpiBufferSize(&rc, parser);
  a = cpiBufferPointer(&rc, parser);
  b = cpiBufferByte(&rc, parser, 0);

  cpiAppendToBuffer(&rc, parser, (char *)"Some test data", 14);

  return cpiBufferSize(0, parser) - initialSize;
}

関連概念
ユーザー定義のパーサー
ユーザー定義拡張機能

関連タスク
C でのパーサーの作成

関連資料
cpiWriteBuffer
cpiWriteBufferFormatted
パーサー・インプリメンテーション関数