Функция 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 | Редактору редактора не удается найти словарь или словарь имеет непредвиденный формат. |
| 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 [только классические приложения] |
| Целевая платформа | Windows |
| Header | imm.h (включая Immdev.h, Windows.h) |
| Библиотека | Imm32.lib |
| DLL | Imm32.dll |