Функция ImmGetGuideLineA (imm.h)
Извлекает сведения об ошибках. Приложения используют сведения для уведомлений пользователей.
Синтаксис
DWORD ImmGetGuideLineA(
[in] HIMC unnamedParam1,
[in] DWORD dwIndex,
[out, optional] LPSTR lpBuf,
[in] DWORD dwBufLen
);
Параметры
[in] unnamedParam1
Обработка входного контекста.
[in] dwIndex
Тип сведений о руководстве для получения. Этот параметр может иметь одно из следующих значений.
| Ценность | Значение |
|---|---|
|
Возвращает уровень ошибки. |
|
Возвращает индекс ошибки. |
|
Возвращает строку сообщения об ошибке. |
|
Возвращает сведения о обратном преобразовании. |
[out, optional] lpBuf
Указатель на буфер, в котором функция получает строку сообщения об ошибке. Этот параметр содержит NULL, если dwIndex не GGL_STRING или GGL_PRIVATE или если dwBufLen имеет значение 0.
[in] dwBufLen
Размер в байтах выходного буфера. Приложение задает этому параметру значение 0, если функция должна вернуть размер буфера, необходимый для получения строки сообщения об ошибке, не включая завершающий символ NULL.
Возвращаемое значение
Возвращает уровень ошибки, индекс ошибки или размер строки сообщения об ошибке в зависимости от значения параметра dwIndex. Если dwIndex GGL_LEVEL, возвращается одно из следующих значений.
| Ценность | Значение |
|---|---|
| GL_LEVEL_ERROR | Ошибка. IME может не продолжаться. |
| GL_LEVEL_FATAL | Неустранимая ошибка. IME не может продолжаться, и данные могут быть потеряны. |
| GL_LEVEL_INFORMATION | Нет ошибки. Сведения доступны для пользователя. |
| GL_LEVEL_NOGUIDELINE | Нет ошибки. Удалите предыдущее сообщение об ошибке, если по-прежнему отображается. |
| GL_LEVEL_WARNING | Непредвиденные входные данные или другой результат. Пользователю следует предупреждать, но IME может продолжаться. |
Если dwIndex GGL_INDEX, возвращаемое значение является одним из следующих значений.
| Ценность | Значение |
|---|---|
| GL_ID_CANNOTSAVE | Словарь или данные статистики не могут быть сохранены. |
| GL_ID_NOCONVERT | IME больше не может преобразовать. |
| GL_ID_NODICTIONARY | IME не может найти словарь, или словарь имеет непредвиденный формат. |
| 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. Для Юникода, если dwBufLen равно 0, возвращаемое значение равно размеру, в байтах, не включая символ Юникода, завершающего значение NULL.
Если dwIndex GGL_PRIVATE, возвращаемое значение — это количество байтов информации, скопированных в буфер. Если dwIndex GGL_PRIVATE и dwBufLen равно 0, возвращаемое значение — это размер буфера, необходимый для получения информации.
Замечания
Приложения обычно вызывают эту функцию после получения команды IMN_GUIDELINE.
Заметка
Заголовок imm.h определяет ImmGetGuideLine в качестве псевдонима, который автоматически выбирает версию ANSI или Юникод этой функции на основе определения константы препроцессора ЮНИКОДа. Сочетание использования псевдонима, нейтрального для кодирования, с кодом, не зависящим от кодирования, может привести к несоответствиям, которые приводят к ошибкам компиляции или среды выполнения. Дополнительные сведения см. в соглашениях о прототипах функций.
Требования
| Требование | Ценность |
|---|---|
| минимальные поддерживаемые клиентские | Windows XP [только классические приложения], установленная поддержка языка Восточной Азии. |
| минимальный поддерживаемый сервер | Windows Server 2003 [только классические приложения] |
| целевая платформа | Виндоус |
| заголовка | imm.h (include Immdev.h, Windows.h) |
| библиотеки |
Imm32.lib |
| DLL | Imm32.dll |
См. также
КАНДИДАТОВ
Функции диспетчера методов ввода