[Now Supported on Windows NT]
ImmGetCompositionString函数检索有关组合字符串的信息。
LONG ImmGetCompositionString(
HIMC 【hIMC】, | |
DWORD 【dwIndex】, | |
LPVOID 【lpBufmt】, | |
DWORD 【dwBufLen】 | |
); |
参数
【hIMC】
处理输入上下文。
【dwIndex】
要检索的信息的索引。该参数可以是输入法编辑器常量中“IME Composition String Values”表中给出的值之一。对于除GCS_CURSORPOS和GCS_DELTASTART之外的每个值,该函数将所请求的信息复制到指定的缓冲区。该函数返回返回值的低16位中的光标和增量位置值。
【lpBufmt】
指向接收请求信息的缓冲区。
【dwBufLen】
缓冲区的大小,以字节为单位。如果为0,则ImmGetCompositionString函数返回完整信息所需的缓冲区大小。
返回值
返回复制到目标缓冲区的字节数,或者如果【dwBufLen】为零,则需要接收所有请求的信息所需的缓冲区大小(以字节为单位)。在出现错误时,函数返回以下负值之一:
值 | 含义 |
IMM_ERROR_NODATA | 组合数据在输入上下文中未准备就绪。 |
IMM_ERROR_GENERAL | IME检测到一般错误。 |
备注
应用程序响应WM_IME_COMPOSITION或WM_IME_STARTCOMPOSITION消息调用此函数。当应用程序调用{??989796078}函数时,IMM将删除该信息。
也可以看看