immGetCompositionStringW 函式 (imm.h)
擷取組合字元串的相關資訊。
語法
LONG ImmGetCompositionStringW(
HIMC unnamedParam1,
DWORD unnamedParam2,
[out, optional] LPVOID lpBuf,
[in] DWORD dwBufLen
);
參數
unnamedParam1
unnamedParam2
[out, optional] lpBuf
函式擷取組合字元串資訊的緩衝區指標。
[in] dwBufLen
輸出緩衝區的大小，以位元組為單位，即使輸出是 Unicode 字串也一樣。 如果函式傳回所需的輸出緩衝區大小，應用程式會將此參數設定為 0。
傳回值
傳回復制到輸出緩衝區的位元組數目。 如果 dwBufLen 設定為 0，則函式會傳回接收所有要求資訊所需的緩衝區大小，不包括終止 Null 字元。 即使要求的資料是 Unicode 字串，傳回值一律是大小，以位元組為單位。
如果失敗，此函式會傳回下列其中一個負錯誤碼：
- IMM_ERROR_NODATA。 組合資料尚未在輸入內容中就緒。
- IMM_ERROR_GENERAL。 輸入法偵測到的一般錯誤。
備註
應用程式會呼叫此函式，以回應 WM_IME_COMPOSITION 或 WM_IME_STARTCOMPOSITION 訊息。 當應用程式呼叫 ImmReleaseCoNtext 函式時，IMM 會移除資訊。
注意 如果您的應用程式搭配 「軟輸入面板」 (SIP) 使用，您必須撰寫程式碼來處理全形平假名和半形片假名。
注意
imm.h 標頭會根據 UNICODE 預處理器常數的定義，將 ImmGetCompositionString 定義為別名，自動選取此函式的 ANSI 或 Unicode 版本。 混合使用編碼中性別名與非編碼中性的程式碼，可能會導致編譯或執行時間錯誤不符。 如需詳細資訊，請參閱 函式原型的慣例。
需求
| 最低支援的用戶端 | Windows XP [僅限傳統型應用程式]，已安裝東亞語言支援。 |
| 最低支援的伺服器 | Windows Server 2003 [僅限傳統型應用程式] |
| 目標平台 | Windows |
| 標頭 | imm.h (包括 Immdev.h、Windows.h) |
| 程式庫 | Imm32.lib |
| Dll | Imm32.dll |