Функция ImmGetDescriptionA (imm.h)

Статья
11/20/2024

Копирует описание 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 или Юникод этой функции на основе определения константы препроцессора ЮНИКОДа. Сочетание использования псевдонима, нейтрального для кодирования, с кодом, не зависящим от кодирования, может привести к несоответствиям, которые приводят к ошибкам компиляции или среды выполнения. Дополнительные сведения см. в соглашениях о прототипах функций.

Требования

Требование	Ценность
минимальные поддерживаемые клиентские	Windows XP [только классические приложения], установленная поддержка языка Восточной Азии., установленная поддержка языка Восточной Азии.
минимальный поддерживаемый сервер	Windows Server 2003 [только классические приложения]
целевая платформа	Виндоус
заголовка	imm.h (include Immdev.h, Windows.h)
библиотеки	Imm32.lib
DLL	Imm32.dll

См. также

диспетчера методов ввода

Функции диспетчера методов ввода

Поделиться через