ImmGetCompositionStringA 函式（imm.h）

發行項
11/20/2024

擷取組合字串的相關信息。

語法

LONG ImmGetCompositionStringA(
                  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 [僅限傳統型應用程式]
目標平臺	窗戶
標頭	imm.h （包括 Immdev.h、Windows.h）
連結庫	Imm32.lib
DLL	Imm32.dll