ImmGetDescriptionA 函数（imm.h）

将 IME 的说明复制到指定的缓冲区。

语法

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

unnamedParam1

[out, optional] lpszDescription

指向一个缓冲区的指针，其中函数检索描述 IME 的以 null 结尾的字符串。

[in] uBufLen

输出缓冲区的大小（以字符为单位）。如果函数返回完整说明所需的缓冲区大小（不包括终止 null 字符），则应用程序将此参数设置为 0。

Windows NT、Windows 2000、Windows XP： 缓冲区的大小以 Unicode 字符为单位，每个字符包含两个字节。如果参数设置为 0，则函数将返回 Unicode 字符中所需的缓冲区大小，不包括 Unicode 终止 null 字符。

返回复制到输出缓冲区的字符数。如果应用程序将 uBufLen 参数设置为 0，则函数将返回接收说明所需的缓冲区大小。这两个值都不包括终止 null 字符。对于 Unicode，该函数返回 Unicode 字符数，不包括 Unicode 终止 null 字符。

注意

imm.h 标头将 ImmGetDescription 定义为一个别名，该别名根据 UNICODE 预处理器常量的定义自动选择此函数的 ANSI 或 Unicode 版本。将中性编码别名与不中性编码的代码混合使用可能会导致编译或运行时错误不匹配。有关详细信息，请参阅函数原型的约定。

要求	价值
最低支持的客户端	Windows XP [仅限桌面应用]，已安装东亚语言支持。已安装东亚语言支持。
支持的最低服务器	Windows Server 2003 [仅限桌面应用]
目标平台	窗户
标头	imm.h（包括 Immdev.h、Windows.h）
库	Imm32.lib
DLL	Imm32.dll