ImmGetDescriptionA 函式（imm.h）

將 IME 的描述複製到指定的緩衝區。

語法

UINT ImmGetDescriptionA(
                  HKL   unnamedParam1,
  [out, optional] LPSTR lpszDescription,
  [in]            UINT  uBufLen
);

unnamedParam1

[out, optional] lpszDescription

緩衝區的指標，函式會擷取描述IME的 Null 終止字串。

[in] uBufLen

輸出緩衝區的大小，以字元為單位。如果函式要傳回完整描述所需的緩衝區大小，則應用程式會將此參數設定為 0，但不包括終止的 Null 字元。

Windows NT、Windows 2000、Windows XP： 緩衝區的大小是以 Unicode 字元為單位，每個字元都包含兩個字節。如果參數設定為 0，則函式會傳回 Unicode 字元所需的緩衝區大小，但不包括 Unicode 終止 Null 字元。

傳回復制到輸出緩衝區的字元數。如果應用程式將 uBufLen 參數設定為 0，則函式會傳回接收描述所需的緩衝區大小。兩個值都未包含終止的 Null 字元。若為 Unicode，函式會傳回 Unicode 字元的數目，不包括 Unicode 終止 Null 字元。

注意

imm.h 標頭會根據 UNICODE 預處理器常數的定義，將 ImmGetDescription 定義為自動選取此函式的 ANSI 或 Unicode 版本。混合使用編碼中性別名與非編碼中性的程序代碼，可能會導致編譯或運行時間錯誤不符。如需詳細資訊，請參閱函式原型的慣例。

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