A.2.2 公開インタフェース一覧

Charset-入力アシスト制御の環境設定制御に関する公開インタフェースの一覧を説明します。

環境設定制御インタフェースは、PUBLIC1インタフェースの一部です。

1. サポート情報取得

サポート情報は、LONG型の戻り値で通知されます。戻り値全32ビットのうちの各ビットが、各々の機能が有効か(1)、無効か(0)を意味します。

環境設定については、項目が多いため、dwOptionを使ってさらにパラメータが細分化されています。

戻り値の定義は、各dwOptionの指定で共通です。

一時動作環境は、アプリケーション内の1つの入力コンテキストでのみ有効な動作環境です。標準動作環境は、レジストリに記憶されるCharset-入力アシスト動作環境です。

dwMainFunc = FJI_EP1_GETSUPPORTINFO
dwSubFunc  = FJI_EP1_GSI_ENVCONTROL
dwOption   = サポート情報を取得する動作環境項目
lpPointer  = NULL

戻り値・・・0x0001のビット = 一時動作環境取得が可能である。
            0x0002のビット = 一時動作環境設定が可能である。
            0x0004のビット = 標準動作環境取得が可能である。
            0x0008のビット = 標準動作環境設定が可能である。

たとえば、「学習レベル」設定項目については、dwOption = FJI_EP1_ENV_MEMORIZELEVELをセットすると、Charset-入力アシスト V9では0x000Fが返されるので、一時的に、レジストリでも参照・更新が可能なことが分かります。

実際に取得・更新をする場合は、dwSubFunc = FJI_EP1_ENV_MEMORIZELEVELとして、dwOptionに適切なパラメータをセットして呼び出してください。

2. 一時動作環境取得

dwMainFunc = FJI_EP1_GETENVIRON_TEMP (=0x0004)
dwSubFunc  = 取得する動作環境項目
dwOption   = dwSubFuncによって異なる
lpPointer  = dwSubFuncによって異なる

戻り値は1である。パラメータの詳細は後述する。
サポートしていない場合は0を返す。
lpPointerが必要な場合、有効なアドレス(IsBadWritePtr APIでFALSEを返す)ではない場合は、-1を返す。

Charset-入力アシストは、dwOptionに値をセットして返すか、lpPointerに用意された領域に文字列などをコピーして返します。
dwOptionとlpPointerの両方に書き込む必要はありません。なお、lpPointerの領域に文字列などを書き込む場合は、dwOptionで指定されたバイト数の領域にコピー可能な場合のみコピーされます。
この取得対象は、IMCハンドル単位でメモリに記憶している動作環境になります。

3. 一時動作環境設定

dwMainFunc = FJI_EP1_SETENVIRON_TEMP (=0x0005)
dwSubFunc  = 設定する動作環境項目
dwOption   = dwSubFuncによって異なる
lpPointer  = dwSubFuncによって異なる

戻り値は1である。パラメータの詳細は後述する。
サポートしていない場合は0を返す。
lpPointerが必要な場合、有効なアドレス(IsBadReadPtr APIでFALSEを返す)ではない場合は、-1を返す。

dwOptionは数値による設定項目、lpPointerは文字列や可変長バイト列の設定、構造体による設定のために使用します。

なお、一部の動作環境項目は、取得だけ可能なものがあります。
この設定対象は、IMCハンドル単位でメモリに記憶している動作環境になります。

参考

サポートしている動作環境項目であっても、dwOptionのパラメータが仕様の範囲外である場合は、戻り値として0を返します。
この戻り値が0かどうかによって、パラメータが有効であるかどうかをテストしないでください。前もってパラメータに範囲がある場合、同一の動作環境項目で設定できる値の範囲が将来増減することはありません。(少なくとも内部で置き換えられ、正しく動作します。)

4. 標準動作環境取得

dwMainFunc = FJI_EP1_GETENVIRON_REG (=0x0006)
dwSubFunc  = 取得する動作環境項目
dwOption   = dwSubFuncによって異なる
lpPointer  = dwSubFuncによって異なる

戻り値は1である。パラメータの詳細は後述する。
サポートしていない場合は0を返す。
lpPointerが必要な場合、有効なアドレス(IsBadWritePtr APIでFALSEを返す)ではない場合は、-1を返す。

Charset-入力アシストは、dwOptionに値をセットして返すか、lpPointerに用意された領域に文字列などをコピーして返します。
dwOptionとlpPointerの両方に書き込む必要はありません。なお、lpPointerの領域に文字列などを書き込む場合は、dwOptionで指定されたバイト数の領域にコピー可能な場合のみコピーされます。
この取得対象は、レジストリに記憶している動作環境になります。

5. 標準動作環境設定

dwMainFunc = FJI_EP1_SETENVIRON_REG (=0x0007)
dwSubFunc  = 設定する動作環境項目
dwOption   = dwSubFuncによって異なる
lpPointer  = dwSubFuncによって異なる

戻り値は1である。パラメータの詳細は後述する。
サポートしていない場合は0を返す。
lpPointerが必要な場合、有効なアドレス(IsBadReadPtr APIでFALSEを返す)ではない場合は、-1を返す。

dwOptionは数値による設定項目、lpPointerは文字列や可変長バイト列の設定、構造体による設定のために使用します。

なお、一部の動作環境項目は、取得だけ可能なものがあります。
この設定対象は、レジストリに記憶してある動作環境になります。

参考