4.1.5 charsetmanager_converter_stream_open

ストリーム情報生成関数です。ストリーム情報は、コード変換における動的な情報（文字列の状態や、統計情報）を管理するのに使われます。

呼び出し形式

charsetmanager_converter_stream_status_ptr  charsetmanager_converter_stream_open_status(
       charsetmanager_converter_property_ptr ccpp,
       const char * source_encoding,
       const char * destination_encoding,
       int * error
);

機能説明

ストリーム情報格納域を取得してポインタを返却します。ストリーム情報は、コード変換中の状態や、コード変換の統計情報を格納するために利用されます。ストリーム情報解放関数（“4.1.7 charsetmanager_converter_stream_close_status”）とセットで呼び出してください。

シフトコードを使用するエンコーディングにおいては、変換元データ、変換先データともに初期シフト状態を半角文字として扱います。ストリーム継続情報初期化関数（4.1.6 charsetmanager_converter_stream_init_status）を使用することで、シフト状態を初期化することができます。

初期シフト状態を全角にして扱いたい場合は、コード変換前にあらかじめ全角文字への切替えを行うシフトコードをコード変換してください。

パラメタ

ccpp(IN): コード変換プロパティ情報格納域のポインタを指定します。コード変換開始関数（“4.1.1 charsetmanager_converter_open”）の復帰値を指定します。

source_encoding(IN): 変換元のエンコーディング形式を文字列で指定します。“表2.4 コード系種別と指定可能なエンコーディング形式”にある入力エンコーディング形式のキーワードを指定してください。

destination_encoding(IN): 変換先のエンコーディング形式を文字列で指定します。“表2.4 コード系種別と指定可能なエンコーディング形式”にある出力エンコーディング形式のキーワードを指定してください。

error(OUT): エラー番号を返却する領域のポインタを指定します。本ポインタがNULLの場合、処理を中断します。関数が正常終了した場合には0が返却され、エラー終了時には1以上の詳細エラー番号が返却されます。エラー番号については、“表4.1 エラー番号一覧”を参照してください。

復帰値

正常終了した場合、ストリーム情報格納域を指すポインタが返却されます。以降のストリーム情報APIとコード変換関数で本ポインタを利用します。

エラー終了した場合、NULLポインタが返却されます。

4.1.5 charsetmanager_converter_stream_open_status