Функция ImmGetDescriptionA (imm.h)
Копирует описание IME в указанный буфер.
Синтаксис
UINT ImmGetDescriptionA(
HKL unnamedParam1,
[out, optional] LPSTR lpszDescription,
[in] UINT uBufLen
);
Параметры
unnamedParam1
[out, optional] lpszDescription
Указатель на буфер, в котором функция извлекает строку, завершающуюся значением NULL, описывающую IME.
[in] uBufLen
Размер выходного буфера (в символах). Приложение задает этому параметру значение 0, если функция возвращает размер буфера, необходимый для полного описания, за исключением завершающего символа NULL.
Windows NT, Windows 2000, Windows XP: Размер буфера состоит из символов Юникода, каждый из которых состоит из двух байтов. Если параметр имеет значение 0, функция возвращает размер буфера, необходимый в символах Юникода, за исключением завершающего символа NULL в Юникоде.
Возвращаемое значение
Возвращает количество символов, скопированных в выходной буфер. Если приложение задает параметру uBufLen значение 0, функция возвращает размер буфера, необходимый для получения описания. Ни то, ни иное значение не содержит завершающий символ NULL. Для Юникода функция возвращает количество символов Юникода, не включая завершающий символ NULL в Юникоде.
Комментарии
Примечание
Заголовок imm.h определяет ImmGetDescription в качестве псевдонима, который автоматически выбирает версию ANSI или Юникод этой функции на основе определения константы препроцессора UNICODE. Сочетание использования псевдонима, не зависящий от кодировки, с кодом, не зависящим от кодировки, может привести к несоответствиям, которые приводят к ошибкам компиляции или среды выполнения. Дополнительные сведения см. в разделе Соглашения для прототипов функций.
Требования
| Минимальная версия клиента | Windows XP [только классические приложения], установленная поддержка восточноазиатских языков. Поддержка восточноазиатских языков установлена. |
| Минимальная версия сервера | Windows Server 2003 [только классические приложения] |
| Целевая платформа | Windows |
| Header | imm.h (включая Immdev.h, Windows.h) |
| Библиотека | Imm32.lib |
| DLL | Imm32.dll |