AIT_IMEGetProperty

機能

入力フォーカスウィンドウと結び付けられたIMEのプロパティまたは機能を取得します。

形式

integer AIT_IMEGetProperty  (
 integer nPropertyInfo     // プロパティ情報
);

引数

nPropertyInfo(入力用)

取得するプロパティ情報を指定してください。

次の値のどれかに該当する必要があります。

意味
IGP_PROPERTYプロパティ情報
IGP_CONVERSION変換機能
IGP_SENTENCEセンテンスモード機能
IGP_UIユーザインタフェース機能
IGP_SETCOMPSTRコンポジション文字列機能
IGP_SELECT選択継承の機能

戻り値

関数が正常に処理された場合の戻り値はnPropertyInfoの値に応じたプロパティまたは機能の値となり,そのほかの場合の戻り値は-1となります。

nPropertyInfoがIGP_PROPERTYの場合戻り値は次の値の組み合わせになります。

意味
IME_PROP_AT_CARETオンの場合,変換ウィンドウはカレットの位置にあります。オフの場合,変換ウィンドウはカレットの近くにあります。
IME_PROP_SPECIAL_UIオンの場合,IMEは標準的なユーザインタフェースを持っていません。この場合は,アプリケーションでIMEウィンドウ内を描画しないでください。
IME_PROP_CANDLIST_START_FROM_1オンの場合,候補リスト内の文字列は1から順に番号が付いています。オフの場合,文字列は0から順に番号が付いています。
IME_PROP_UNICODEオンの場合,入力コンテキスト文字列にはUnicode文字が含まれます。オフの場合,文字列には1バイト文字と2バイト文字が含まれます。

nPropertyInfoがIGP_UIの場合,戻り値は次の値の組み合わせになります。

意味
UI_CAP_2700テキストの印字方向として,0または2700の値をサポートします。
UI_CAP_ROT90テキストの印字方向として,0,900,1800,または2700の値をサポートします。
UI_CAP_ROTANY任意の印字方向をサポートします。

nPropertyInfoがIGP_SETCOMPSTRの場合,戻り値は次の値の組み合わせになります。

意味
SCS_CAP_COMPSTRIMESetCompositionStringのSCS_SETSTR値を使用してコンポジション文字列を作成できます。
SCS_CAP_MAKEREADIMESetCompositionStringのSCS_SETSTR値を使用すると,対応するコンポジション文字列から読み取り文字列を作成できます。

nPropertyInfoがIGP_SELECTの場合,戻り値は次の値の組み合わせになります。

意味
SELECT_CAP_CONVERSIONIMEが新たに選択された場合,変換モードを継承します。
SELECT_CAP_SENTENCEIMEが新たに選択された場合,センテンスモードを継承します。

関数が-1を返した場合には,AIT_GetLastErrorを使用して拡張エラーコードを取得できます。

AIT_GetLastErrorが返す可能性のあるエラーコードを次に示します。

拡張エラー番号エラーコード
87ERROR_INVALID_PARAMETER