ImmGetCandidateListA 函数 (immdev.h)

检索候选列表。

语法

DWORD ImmGetCandidateListA(
                  HIMC            unnamedParam1,
  [in]            DWORD           deIndex,
  [out, optional] LPCANDIDATELIST lpCandList,
  [in]            DWORD           dwBufLen
);

参数

unnamedParam1

[in] deIndex

候选列表的从零开始的索引。

[out, optional] lpCandList

指向一个 CANDIDATELIST 结构的指针,函数在其中检索候选列表。

[in] dwBufLen

要接收候选列表的缓冲区的大小(以字节为单位)。 如果函数仅返回所需的输出缓冲区大小,则应用程序可以为此参数指定 0。

返回值

如果成功,则返回复制到候选列表缓冲区的字节数。 如果应用程序为 dwBufLen 参数提供了 0,则函数将返回候选列表缓冲区所需的大小。

如果函数不成功,则返回 0。

注解

注意

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

要求

要求
最低受支持的客户端 Windows XP [仅限桌面应用],已安装东亚语言支持。
最低受支持的服务器 Windows Server 2003 [仅限桌面应用]
目标平台 Windows
标头 immdev.h (包括 Immdev.h、Windows.h)
Library Imm32.lib
DLL Imm32.dll

另请参阅

候选列表

输入法管理器

输入法管理器函数