ImmGetGuideLineW 函数 (immdev.h)

项目
02/29/2024

检索有关错误的信息。应用程序将这些信息用于用户通知。

语法

DWORD ImmGetGuideLineW(
  [in]            HIMC   unnamedParam1,
  [in]            DWORD  dwIndex,
  [out, optional] LPWSTR lpBuf,
  [in]            DWORD  dwBufLen
);

参数

[in] unnamedParam1

输入上下文的句柄。

[in] dwIndex

要检索的指南信息的类型。此参数可以具有以下值之一。

值	含义
GGL_LEVEL	返回错误级别。
GGL_INDEX	返回错误索引。
GGL_STRING	返回错误消息字符串。
GGL_PRIVATE	返回有关反向转换的信息。

[out, optional] lpBuf

指向函数在其中检索错误消息字符串的缓冲区的指针。如果 dwIndex 未GGL_STRING或GGL_PRIVATE或 dwBufLen 设置为 0，则此参数包含 NULL。

[in] dwBufLen

输出缓冲区的大小（以字节为单位）。如果函数返回接收错误消息字符串（不包括终止 null 字符）所需的缓冲区大小，则应用程序将此参数设置为 0。

返回值

返回错误级别、错误索引或错误消息字符串的大小，具体取决于 dwIndex 参数的值。如果 dwIndex 为GGL_LEVEL，则返回为以下值之一。

值	含义
GL_LEVEL_ERROR	错误。输入法可能无法继续。
GL_LEVEL_FATAL	错误。输入法无法继续，数据可能会丢失。
GL_LEVEL_INFORMATION	无错误。信息可供用户使用。
GL_LEVEL_NOGUIDELINE	无错误。如果仍可见，请删除以前的错误消息。
GL_LEVEL_WARNING	意外的输入或其他结果。应警告用户，但输入法可以继续。

如果 dwIndex GGL_INDEX，则返回值为以下值之一。

值	含义
GL_ID_CANNOTSAVE	无法保存字典或统计信息。
GL_ID_NOCONVERT	输入法无法再转换。
GL_ID_NODICTIONARY	输入法找不到字典，或者字典的格式意外。
GL_ID_NOMODULE	IME 找不到所需的模块。
GL_ID_READINGCONFLICT	发生读取冲突。例如，某些元音不能组合在一起形成一个字符。
GL_ID_TOOMANYSTROKE	一个字符或一个子句的笔划太多。
GL_ID_TYPINGERROR	键入错误。 IME 无法处理此键入。
GL_ID_UNKNOWN	未知错误。请参阅错误消息字符串。
GL_ID_INPUTREADING	IME 接受最终用户的读取字符输入。
GL_ID_INPUTRADICAL	IME 接受来自最终用户的激进字符输入。
GL_ID_INPUTCODE	IME 接受最终用户的字符代码输入。
GL_ID_CHOOSECANDIDATE	IME 接受最终用户的候选字符串选择。
GL_ID_REVERSECONVERSION	可通过调用 ImmGetGuideLine 获取有关反向转换的信息，并指定GGL_PRIVATE。检索到的信息采用 CANDIDATELIST 格式。

如果 dwIndex GGL_STRING，则返回值是复制到缓冲区的字符串的字节数。但是，如果 dwBufLen 为 0，则返回值是接收字符串所需的缓冲区大小，不包括终止 null 字符。对于 Unicode，如果 dwBufLen 为 0，则返回值为大小（以字节为单位），不包括 Unicode 终止 null 字符。

如果GGL_PRIVATE dwIndex ，则返回值是复制到缓冲区的信息的字节数。如果 dwIndex GGL_PRIVATE且 dwBufLen 为 0，则返回值是接收信息所需的缓冲区大小。

注解

应用程序通常在收到 IMN_GUIDELINE 命令后调用此函数。

注意

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

要求

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

另请参阅

ImmGetGuideLineW 函数 (immdev.h)

语法

参数

返回值

注解

要求

另请参阅

反馈

反馈

其他资源