immGetGuideLineA 函式 (imm.h)
擷取錯誤的相關信息。 應用程式會使用使用者通知的資訊。
語法
DWORD ImmGetGuideLineA(
[in] HIMC unnamedParam1,
[in] DWORD dwIndex,
[out, optional] LPSTR lpBuf,
[in] DWORD dwBufLen
);
參數
[in] unnamedParam1
輸入內容的句柄。
[in] dwIndex
要擷取的指導方針信息類型。 此參數可以有下列其中一個值。
| 值 | 意義 |
|---|---|
|
傳回錯誤層級。 |
|
傳回錯誤索引。 |
|
傳回錯誤訊息字串。 |
|
傳回反向轉換的相關信息。 |
[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 | 輸入法接受終端使用者的字元碼輸入。 |
| 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 標頭會將 ImmGetGuideLine 定義為別名，根據 UNICODE 預處理器常數的定義，自動選取此函式的 ANSI 或 Unicode 版本。 混合使用編碼中性別名與非編碼中性的程序代碼，可能會導致編譯或運行時間錯誤不符。 如需詳細資訊，請參閱 函式原型的慣例。
規格需求
| 需求 | 值 |
|---|---|
| 最低支援的用戶端 | Windows XP [僅限傳統型應用程式]，已安裝東亞語言支援。 |
| 最低支援的伺服器 | Windows Server 2003 [僅限桌面應用程式] |
| 目標平台 | Windows |
| 標頭 | imm.h (包括 Immdev.h、Windows.h) |
| 程式庫 | Imm32.lib |
| Dll | Imm32.dll |