ImmGetGuideLineA 関数 (imm.h)

エラーに関する情報を取得します。 アプリケーションは、ユーザー通知に情報を使用します。

構文

DWORD ImmGetGuideLineA(
  [in]            HIMC  unnamedParam1,
  [in]            DWORD dwIndex,
  [out, optional] LPSTR lpBuf,
  [in]            DWORD dwBufLen
);

パラメーター

[in] unnamedParam1

入力コンテキストを処理します。

[in] dwIndex

取得するガイドライン情報の種類。 このパラメーターには、次のいずれかの値を指定できます。

意味
GGL_LEVEL
エラー レベルを返します。
GGL_INDEX
エラー インデックスを返します。
GGL_STRING
エラー メッセージ文字列を返します。
GGL_PRIVATE
逆変換に関する情報を返します。

[out, optional] lpBuf

関数がエラー メッセージ文字列を取得するバッファーへのポインター。 dwIndex がGGL_STRINGまたはGGL_PRIVATEされていない場合、または dwBufLen が 0 に設定されている場合、このパラメーターには NULL が含まれます。

[in] dwBufLen

出力バッファーのサイズ (バイト単位)。 アプリケーションは、関数がエラー メッセージ文字列を受信するために必要なバッファー サイズを返す場合に、終了 null 文字を含まない 0 に設定します。

戻り値

dwIndex パラメーターの値に応じて、エラー レベル、エラー インデックス、またはエラー メッセージ文字列のサイズを返します。 dwIndex がGGL_LEVELの場合、戻り値は次のいずれかの値になります。

意味
GL_LEVEL_ERROR エラー。 IME を続行できない場合があります。
GL_LEVEL_FATAL 致命的なエラー。 IME を続行できず、データが失われる可能性があります。
GL_LEVEL_INFORMATION エラーなし。 ユーザーは情報を入手できます。
GL_LEVEL_NOGUIDELINE エラーなし。 表示されている場合は、前のエラー メッセージを削除します。
GL_LEVEL_WARNING 予期しない入力またはその他の結果。 ユーザーに警告が表示されますが、IME は続行できます。
 

dwIndex がGGL_INDEXの場合、戻り値は次のいずれかの値になります。

意味
GL_ID_CANNOTSAVE ディクショナリまたは統計データを保存できません。
GL_ID_NOCONVERT IME はこれ以上変換できません。
GL_ID_NODICTIONARY IME でディクショナリが見つからないか、ディクショナリの形式が予期しない場合。
GL_ID_NOMODULE IME で必要なモジュールが見つかりません。
GL_ID_READINGCONFLICT 読み取りの競合が発生しました。 たとえば、一部の母音を組み合わせて 1 文字を形成することはできません。
GL_ID_TOOMANYSTROKE 1 つの文字または 1 つの句に対してストロークが多すぎます。
GL_ID_TYPINGERROR 入力エラー。 IME はこの型指定を処理できません。
GL_ID_UNKNOWN 不明なエラー。 エラー メッセージ文字列を参照してください。
GL_ID_INPUTREADING IME は、エンド ユーザーからの文字入力の読み取りを受け入れます。
GL_ID_INPUTRADICAL IME は、エンド ユーザーからのラジカル文字入力を受け入れます。
GL_ID_INPUTCODE IME は、エンド ユーザーからの文字コード入力を受け入れます。
GL_ID_CHOOSECANDIDATE IME は、エンド ユーザーからの候補文字列の選択を受け入れます。
GL_ID_REVERSECONVERSION 逆変換に関する情報は、 ImmGetGuideLine を呼び出して、GGL_PRIVATEを指定することで利用できます。 取得される情報は CANDIDATELIST 形式です。
 

dwIndex がGGL_STRINGの場合、戻り値はバッファーにコピーされた文字列のバイト数です。 ただし、 dwBufLen が 0 の場合、戻り値は文字列を受け取るために必要なバッファー サイズであり、終端の null 文字は含まれません。 Unicode の場合、 dwBufLen が 0 の場合、戻り値はサイズ (Unicode 終端 null 文字を含まないバイト単位) になります。

dwIndex がGGL_PRIVATEの場合、戻り値はバッファーにコピーされた情報のバイト数です。 dwIndex がGGL_PRIVATEで dwBufLen が 0 の場合、戻り値は情報を受信するために必要なバッファー サイズです。

注釈

アプリケーションは通常、 IMN_GUIDELINE コマンドを受け取った後にこの関数を呼び出します。

注意

imm.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択するエイリアスとして ImmGetGuideLine を定義します。 encoding-neutral エイリアスの使用を encoding-neutral ではないコードと混在すると、コンパイル エラーまたはランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「 関数プロトタイプの規則」を参照してください。

要件

要件
サポートされている最小のクライアント Windows XP [デスクトップ アプリのみ]、東アジア言語のサポートがインストールされています。
サポートされている最小のサーバー Windows Server 2003 (デスクトップ アプリのみ)
対象プラットフォーム Windows
ヘッダー imm.h (Immdev.h、Windows.h を含む)
Library Imm32.lib
[DLL] Imm32.dll

こちらもご覧ください

CANDIDATELIST

IMN_GUIDELINE

入力メソッド マネージャー

入力メソッド マネージャー関数