ページの先頭行へ戻る
Interstage Charset Manager Standard Edition V10 使用手引書 入力機能編
FUJITSU Software

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

1. 辞書管理サービスのサポート情報取得

dwMainFunc = FJI_EP1_GETSUPPORTINFO
dwSubFunc  = FJI_EP1_GSI_DICMANAGER
dwOption   = FJI_EP1_GSI_DM_LEVEL2
lpPointer  = NULL
戻り値(次のビットのOR値:サポートされるものはビットON)
  FJI_EP1_GSI_DM_GETDICFILEPACK    (=0x0004) 辞書ファイル設定の取得
  FJI_EP1_GSI_DM_SETDICFILEPACK    (=0x0008) 辞書ファイル設定の設定
  FJI_EP1_GSI_DM_CHANGEDICFILEPACK (=0x0010) 辞書ファイル設定の切替え
  FJI_EP1_GSI_DM_GETDICFILEPACKW   (=0x0020) 辞書ファイル設定の取得					(Unicode)
  FJI_EP1_GSI_DM_SETDICFILEPACKW   (=0x0040) 辞書ファイル設定の設定					(Unicode)
  FJI_EP1_GSI_DM_GETPRIORITYDIC    (=0x0080) 優先辞書切替え状態の取得
  FJI_EP1_GSI_DM_CHANGEPRIORITYDIC (=0x0100) 優先辞書切替え
  FJI_EP1_GSI_DM_GETMANAGEMENTCODE (=0x0200) 入力用マスタコード系の取得
  FJI_EP1_GSI_DM_CHANGEMANAGEMENTCODE (=0x0400) 入力用マスタコード系の切替え

2. 辞書ファイル設定の取得

dwMainFunc = FJI_EP1_GETDICFILEPACK
dwSubFunc  = 0 (リザーブ) 
dwOption   = 取得する辞書ファイル設定
             FJI_EP1_DFP_DEFAULT (=0x0000): デフォルト
             FJI_EP1_DFP_APPLICATION (=0x0001): アプリケーション指定の辞書ファイル設定
lpPointer  = FJI_DICFILEPACKの領域へのポインタ (呼び元が確保)
戻り値
  1    = 正常終了
  0    = サポートしていない
  -1   = lpPointerの領域に書き込みできない
  -2   = レジストリ情報が異常(要再インストール)
  -8   = 辞書ファイル設定の設定が行われていない
  -128 = その他のエラー

使用中の辞書ファイルのパスをlpPointerの示す領域に格納します。
辞書ファイルのパスを格納する領域を示すポインタ(FJI_DICFILEPACK構造体のlpUserDicやlpOptionDicなど)は _MAX_PATH 以上を用意してください。
格納領域を示すポインタが NULL であった場合、その辞書ファイルのパスは取得されません。すべての領域ポインタが NULL であった場合は正常終了します。
格納されるファイルパスは、ソース辞書・単漢字辞書・出力可能コード指定の定義ファイルはフルパスになりますが、その他のファイルはフルパスになるとは限りません。フルパスでない場合は、ファイル名を返します。
(例:"オプション辞書.opt")

【辞書ファイル設定の構造体定義】

#define FJI_OPTIONDICMAX  40  // オプション辞書数Max

// 辞書ファイル設定構造体
typedef struct _tagFJI_DICFILEPACK {
    UCHAR *lpName;         // 辞書ファイル設定の名称 51バイト
                           // (null含む)
    UCHAR *lpSrcDic;       // ソース辞書
    UCHAR *lpKanDic;       // 単漢字辞書
    UCHAR *lpDFile;        // テーブル辞書
    UCHAR *lpUserDic;      // ユーザ辞書
    UCHAR *lpHistoryDic;   // 入力予測辞書
    UCHAR *lpAssistantDic; // NULLを指定する
    UCHAR *lpOptionDic[FJI_OPTIONDICMAX];  // オプション辞書
                           // (配列の先頭からNULLが現れるまでが有効)
    UCHAR *lpScopeFile;    // 出力可能コード指定の定義ファイル
} FJI_DICFILEPACK;

3. 辞書ファイル設定の取得(Unicode)

dwMainFunc = FJI_EP1_GETDICFILEPACKW
dwSubFunc  = 0 (リザーブ) 
dwOption   = 取得する辞書ファイル設定
             FJI_EP1_DFP_DEFAULT (=0x0000): デフォルト
             FJI_EP1_DFP_APPLICATION (=0x0001): アプリケーション指定の辞書ファイル設定
lpPointer  = FJI_DICFILEPACKWの領域へのポインタ (呼び元が確保)
戻り値
  1    = 正常終了
  0    = サポートしていない
  -1   = lpPointerの領域に書き込みできない
  -2   = レジストリ情報が異常(要再インストール)
  -8   = 辞書ファイル設定の設定が行われていない
  -128 = その他のエラー

使用中の辞書ファイルのパスをlpPointerの示す領域に格納します。
辞書ファイルのパスを格納する領域を示すポインタ(FJI_DICFILEPACKW構造体のlpUserDicやlpOptionDicなど)は _MAX_PATH 以上を用意してください。
格納領域を示すポインタが NULL であった場合、その辞書ファイルのパスは取得されません。すべての領域ポインタが NULL であった場合は正常終了します。

格納されるファイルパスは、ソース辞書・単漢字辞書・出力可能コード指定の定義ファイルはフルパスになりますが、その他のファイルはフルパスになるとは限りません。フルパスでない場合は、ファイル名を返します。
(例:"オプション辞書.opt")

【辞書ファイル設定の構造体定義】

#define FJI_OPTIONDICMAX  40  // オプション辞書数Max

// 辞書ファイル設定構造体
typedef struct _tagFJI_DICFILEPACKW {
    WCHAR *lpName;         // 辞書ファイル設定の名称 51バイト
                           // (null含む)。辞書ファイル設定の設定時、
                           // シフトJIS文字列に変換後51バイト以降は
                           // 無効。英字のみでは50文字、漢字などの
                           // 2バイト文字では25文字が有効
    WCHAR *lpSrcDic;       // ソース辞書
    WCHAR *lpKanDic;       // 単漢字辞書
    WCHAR *lpDFile;        // テーブル辞書
    WCHAR *lpUserDic;      // ユーザ辞書
    WCHAR *lpHistoryDic;   // 入力予測辞書
    WCHAR *lpAssistantDic; // おてがる単語登録辞書(NULLを指定する)
    WCHAR *lpOptionDic[FJI_OPTIONDICMAX];  // オプション辞書
                           // (配列の先頭からNULLが現れるまでが有効)
    WCHAR *lpScopeFile;    // 出力可能コード指定の定義ファイル
} FJI_DICFILEPACKW;

4. 辞書ファイル設定の設定

dwMainFunc = FJI_EP1_SETDICFILEPACK
dwSubFunc  = 0 (リザーブ)
dwOption   = 設定する辞書ファイル設定(必ず1を設定すること)
             FJI_EP1_DFP_DEFAULT (=0x0000): デフォルト
             FJI_EP1_DFP_APPLICATION (=0x0001): アプリケーション指定の辞書ファイル設定
lpPointer  = FJI_DICFILEPACKの領域へのポインタ (呼び元が確保)
戻り値
  1    = 正常終了
  0    = サポートしていない
  -1   = lpPointerの領域が読み込めない
  -3   = メモリ不足
  -4   = 指定のパスまたはファイルが存在しない
  -128 = その他のエラー

設定は一時的なもので、この機能を呼び出したプロセスでのみ有効です。
辞書切替え後の変換結果でも学習されます。他の入力フィールドの変換結果に影響を与えたくない場合は、その入力フィールドでのみ学習しないようにするか、学習する辞書(ユーザ辞書・入力予測辞書)を切替えてください。

ユーザ辞書をデフォルトから切替えた場合は、その入力フィールドでは単語登録は起動できなくなります。
辞書ツールキットを起動したときは、常にデフォルトの状態になります。辞書を切替えた入力フィールドで辞書ツールキットを起動しても、切替え後の状態は表示されません。

辞書ファイルのソース辞書・単漢字辞書・テーブル辞書・ユーザ辞書・入力予測辞書は必須です。どれかがNULLであった場合には、エラーを返します。
名称・ファイル名は特殊文字を使わないシフトJIS文字列のみとします。
ファイル名はフルパスか、またはファイル名のみを有効とします。ただし、ソース辞書・単漢字辞書・出力可能コード指定の定義ファイルはフルパスでなければなりません。ファイル名は8.3形式を推奨します。
辞書ファイル設定を変更した場合には、辞書ファイル設定の切替えを呼び出してください。辞書ファイル設定の設定を呼び出したあと、切替えを呼び出す前に辞書ファイル設定の取得を呼び出した場合、実際に使用されている辞書ではなく、先程設定された辞書ファイル設定を返します。

注意

辞書ファイル設定の構造体FJI_DICFILEPACKへの指定について

  • この構造体に「出力可能コード指定の定義ファイル」を指定する際に、Charset-入力アシスト V8以前のスコープファイルを指定することはできません。

  • 入力用マスタコード系が「JEF」または「Unicode-JEF」の場合には、「出力可能コード指定の定義ファイル」にJEF運用の場合のスコープファイルを指定することができます。

  • 入力用マスタコード系が上記以外の場合に、「出力可能コード指定の定義ファイル」にJEF運用の場合のスコープファイルを指定すると、辞書ファイル設定の切替えを呼び出したときにエラーとなります。

5. 辞書ファイル設定の設定(Unicode)

dwMainFunc = FJI_EP1_SETDICFILEPACKW
dwSubFunc  = 0 (リザーブ)
dwOption   = 設定する辞書ファイル設定(必ず1を設定すること)
             FJI_EP1_DFP_DEFAULT (=0x0000): デフォルト
             FJI_EP1_DFP_APPLICATION (=0x0001): アプリケーション指定の辞書ファイル設定
lpPointer  = FJI_DICFILEPACKWの領域へのポインタ (呼び元が確保)
戻り値
  1    = 正常終了
  0    = サポートしていない
  -1   = lpPointerの領域が読み込めない
  -3   = メモリ不足
  -4   = 指定のパスまたはファイルが存在しない
  -128 = その他のエラー

設定は一時的なもので、この機能を呼び出したプロセスでのみ有効です。
辞書切替え後の変換結果でも学習されます。他の入力フィールドの変換結果に影響を与えたくない場合は、その入力フィールドでのみ学習しないようにするか、学習する辞書(ユーザ辞書・入力予測辞書)を切替えてください。

ユーザ辞書をデフォルトから切替えた場合は、その入力フィールドでは単語登録は起動できなくなります。
辞書ツールキットを起動したときは、常にデフォルトの状態になります。辞書を切替えた入力フィールドで辞書ツールキットを起動しても、切替え後の状態は表示されません。

辞書ファイルのソース辞書・単漢字辞書・テーブル辞書・ユーザ辞書・入力予測辞書は必須です。どれかがNULLであった場合には、エラーを返します。
名称・ファイル名は特殊文字を使わないシフトJIS文字列のみとします。
ファイル名はフルパスか、またはファイル名のみを有効とします。ただし、ソース辞書・単漢字辞書・出力可能コード指定の定義ファイルはフルパスでなければなりません。ファイル名は8.3形式を推奨します。
辞書ファイル設定を変更した場合には、辞書ファイル設定の切替えを呼び出してください。辞書ファイル設定の設定を呼び出したあと、切替えを呼び出す前に辞書ファイル設定の取得を呼び出した場合、実際に使用されている辞書ではなく、先程設定された辞書ファイル設定を返します。

注意

辞書ファイル設定の構造体FJI_DICFILEPACKWへの指定について

  • この構造体に「出力可能コード指定の定義ファイル」を指定する際に、Charset-入力アシスト V8以前のスコープファイルを指定することはできません。

  • 入力用マスタコード系が「JEF」または「Unicode-JEF」の場合には、「出力可能コード指定の定義ファイル」にJEF運用の場合のスコープファイルを指定することができます。

  • 入力用マスタコード系が上記以外の場合に、「出力可能コード指定の定義ファイル」にJEF運用の場合のスコープファイルを指定すると、辞書ファイル設定の切替えを呼び出したときにエラーとなります。

6. 辞書ファイル設定の切替え

dwMainFunc = FJI_EP1_CHANGEDICFILEPACK
dwSubFunc  = 0 (リザーブ)
dwOption   = 切替える辞書ファイル設定
             FJI_EP1_DFP_DEFAULT (=0x0000): デフォルト
             FJI_EP1_DFP_APPLICATION (=0x0001): アプリケーション指定の辞書ファイル設定
lpPointer  = NULL (リザーブ)
戻り値
  1   = 正常終了
  0   = サポートしていない
 -1   = lpPointerの領域が読み込めない
 -2   = レジストリ情報が異常(要再インストール)
 -3   = メモリ不足
 -4   = 指定のパスまたはファイルが存在しない
 -5   = 他の辞書管理サービスが動作中である、あるいは辞書書き換え作業中
 -6   = 有効な辞書ファイルではない
 -7   = 指定の辞書はシステムによりアクセスが拒否された
 -8   = 辞書ファイル設定の設定が行われていない
 -9   = 辞書を作成することができない、または辞書数の上限に達している
 -10  = 変換エンジンの初期化エラー
 -11  = 変換エンジンの終了エラー
 -128 = その他のエラー

4. 辞書ファイル設定の設定」の前に、この機能が呼び出された場合は、エラーを返します。
設定されたFJI_DICFILEPACK構造体のファイルが見つからなかった場合もエラーを返します。例外としてUserDic(ユーザ辞書)とHistoryDic(入力予測辞書)の示すファイルが見つからなかった場合のみ、そのファイル名でユーザ辞書、入力予測辞書を作成します。ただし、フルパスで指定されていた場合はエラーとなります。また、整合性レベル低で動作している場合には、ユーザ辞書と入力予測辞書は作成されずにエラーとなります。
ここで作成した辞書ファイルは、プロセス終了後も残りますが、ユーザ辞書は辞書ツールキットで削除することができます。
8. 優先辞書切替え」で使用する優先辞書(氏名、地名)の辞書形式はオプション辞書ですが、「4. 辞書ファイル設定の設定」でオプション辞書として指定した場合はエラーを返します。切替え後の動作に FJI_EP1_DFP_APPLICATIONを指定した場合は、入力モードウィンドウのボタンは「特別」ボタンとなります。FJI_EP1_DFP_DEFAULTを指定した場合は、「標準」ボタンとなります。ただし、「標準」「特別」のボタンは、「8. 優先辞書切替え」の状態にも影響します。

7. 優先辞書切替え情報の取得

dwMainFunc = FJI_EP1_GETPRIORITYDIC 
dwSubFunc  = 0 (リザーブ)
dwOption   = 0 (リザーブ)
lpPointer  = 状態格納領域へのポインタ(DWORD型を呼び元が確保)
戻り値
  1   = 正常終了
 -1   = lpPointerの領域に書き込めない
 -128 = その他のエラー

現在使用している優先辞書切替え状態(優先モード)を取得します。
表示状態を格納する領域へのポインタはDWORD型で用意してください。格納領域を示すポインタがNULLの場合は、優先辞書切替え状態は取得しません。

優先辞書切替え状態は、0(標準モード)、1(氏名優先モード)、2(氏名専門モード)、3(地名優先モード)、4(地名専門モード)のいずれかが格納されます。

8. 優先辞書切替え

dwMainFunc = FJI_EP1_CHANGEPRIORITYDIC 
dwSubFunc  = 0 (リザーブ)
dwOption   = 切替える優先辞書
             FJI_EP1_CPD_DEFAULT      (=0x0000):一般
             FJI_EP1_CPD_NAME         (=0x0001):氏名優先
             FJI_EP1_CPD_NAMEONLY     (=0x0002):氏名専門
             FJI_EP1_CPD_ADDRESS      (=0x0003):地名優先
             FJI_EP1_CPD_ADDRESSONLY  (=0x0004):地名専門
lpPointer  = NULL(リザーブ)
戻り値
  1   = 正常終了
  0   = サポートしていない
 -2   = レジストリ情報が異常(要再インストール)
 -3   = メモリ不足
 -4   = 指定のパスまたはファイルが存在しない
 -5   = 他の辞書管理サービスが動作中である、あるいは辞書書き換え作業中
 -6   = 有効な辞書ファイルではない
 -7   = 指定の辞書はシステムによりアクセスが拒否された
 -10  = 変換エンジンの初期化エラー
 -11  = 変換エンジンの終了エラー
 -128 = その他のエラー

指定した優先辞書に切替えます(優先モードを変更します)。
氏名優先を指定した場合には変換候補の先頭に氏名、地名優先を指定した場合には変換候補の先頭に地名が表示されるように設定されます。なお、優先辞書を切替えた場合でも、氏名、地名ともに候補が存在しない読みに対しては、デフォルトと同様の変換結果となります。

また、氏名専門を指定した場合には氏名の変換候補のみ、地名専門を指定した場合には、地名の変換候補のみ表示されるように設定されます。

切替え後の動作に FJI_EP1_CPD_NAME、FJI_EP1_CPD_NAMEONLY、FJI_EP1_CPD_ADDRESS、またはFJI_EP1_CPD_ADDRESSONLYを指定した場合は、入力モードウィンドウのボタンは「特別」ボタンとなります。FJI_EP1_CPD_DEFAULTを指定した場合は、「標準」ボタンとなります。ただし、「標準」「特別」のボタンは、「6. 辞書ファイル設定の切替え」の状態にも影響します。

9. 入力用マスタコード系の取得

dwMainFunc = FJI_EP1_GETMANAGEMENTCODE
dwSubFunc  = 0 (リザーブ)
dwOption   = 0 (リザーブ)
lpPointer  =入力用マスタコード系を表す値の格納領域へのポインタ(DWORD型を呼び元が確保)
戻り値
  1   = 正常終了
 -1   = lpPointerの領域に書き込めない
 -128 = その他のエラー

現在の入力用マスタコード系を取得し、この機能を呼び出したプロセスの値を返します。

資源配付が行われておらず、かつ入力用マスタコード系の切替えを呼び出していない状態でこの機能を呼び出した場合は、入力用マスタコード系を表す値の格納領域に-1を格納します。

lpPointerがNULLであった場合は入力用マスタコード系の値は取得せず、戻り値に-1を返します。

入力用マスタコード系の値の意味は「10. 入力用マスタコード系の切替え」を参照してください。

10. 入力用マスタコード系切替え

dwMainFunc = FJI_EP1_CHANGEMANAGEMENTCODE
dwSubFunc  = 0 (リザーブ)
dwOption   = 入力用マスタコード系を表す値
             2 : シフトJIS(MS)
             3 : Unicode
             4 : JEF
             5 : Unicode-JEF
             6 : JIPS
             7 : KEIS
             8 : DBCS-Host
             13: Unicode(2004MS)
lpPointer  = NULL (リザーブ)
戻り値
  1   = 正常終了
  0   = サポートしていない
 -128 = その他のエラー

入力用マスタコード系を設定します。

設定は一時的なものであり、この機能を呼び出したプロセスでのみ有効です。

注意

この機能を呼び出した場合は、入力モードウィンドウの辞書モードボタンは「特別」がマスク状態で表示されます。この状態のときは、次の点に注意してください。

  • 入力モードウィンドウのマウスクリックやショートカットキーで辞書モードを切り替えることはできません。ただし、外部制御インタフェースからは優先辞書切替え、辞書ファイル設定の切替えで辞書モードを切り替えることができます。

  • この状態は、この機能を呼び出したプロセスが終了するまで継続します。例えば、初期状態の入力用マスタコード系を再設定してもマスク状態は解除されません。