共用方式為

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

輸出緩衝區的大小，以位元組為單位。 如果函式要傳回接收錯誤訊息字串所需的緩衝區大小，則應用程式會將此參數設定為0，不包括終止的Null字元。

傳回值

根據 dwIndex 參數的值，傳回錯誤層級、錯誤索引或錯誤訊息字串的大小。 如果 dwIndex 是GGL_LEVEL，則傳回是下列其中一個值。

價值 意義
GL_LEVEL_ERROR 錯誤。 輸入法可能無法繼續。
GL_LEVEL_FATAL 嚴重錯誤。 輸入法無法繼續，而且數據可能會遺失。
GL_LEVEL_INFORMATION 沒有錯誤。 使用者可以使用資訊。
GL_LEVEL_NOGUIDELINE 沒有錯誤。 如果仍然可見，請移除先前的錯誤訊息。
GL_LEVEL_WARNING 非預期的輸入或其他結果。 用戶應該受到警告，但輸入法可以繼續。
 

如果 dwIndex 是GGL_INDEX，則傳回值為下列其中一個值。

價值 意義
GL_ID_CANNOTSAVE 無法儲存字典或統計數據數據。
GL_ID_NOCONVERT 輸入法無法再轉換。
GL_ID_NODICTIONARY 輸入法找不到字典，或字典具有非預期的格式。
GL_ID_NOMODULE 輸入法找不到所需的模組。
GL_ID_READINGCONFLICT 發生讀取衝突。 例如，某些音符無法放在一起以形成一個字元。
GL_ID_TOOMANYSTROKE 一個字元或一個子句的筆劃太多。
GL_ID_TYPINGERROR 輸入錯誤。 輸入法無法處理此輸入。
GL_ID_UNKNOWN 未知的錯誤。 請參閱錯誤訊息字串。
GL_ID_INPUTREADING 輸入法接受終端使用者的讀取字元輸入。
GL_ID_INPUTRADICAL 輸入法接受使用者的根本字元輸入。
GL_ID_INPUTCODE IME 正在接受終端使用者的字元碼輸入。
GL_ID_CHOOSECANDIDATE 輸入法正在接受終端使用者的候選字串選取專案。
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 預處理器常數的定義，將 ImmGetGuideLine 定義為自動選取此函式的 ANSI 或 Unicode 版本。 混合使用編碼中性別名與非編碼中性的程序代碼，可能會導致編譯或運行時間錯誤不符。 如需詳細資訊，請參閱函式原型的 慣例。

要求

要求 價值
最低支援的用戶端 Windows XP [僅限傳統型應用程式]，已安裝東亞語言支援。
支援的最低伺服器 Windows Server 2003 [僅限傳統型應用程式]
目標平臺 窗戶
標頭 imm.h （包括 Immdev.h、Windows.h）
連結庫 Imm32.lib
DLL Imm32.dll

另請參閱

CANDIDATELIST

IMN_GUIDELINE

Input Method Manager

Input Method Manager 函式