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

Статья
03/13/2024

Извлекает список кандидатов.

Синтаксис

DWORD ImmGetCandidateListA(
                  HIMC            unnamedParam1,
  [in]            DWORD           deIndex,
  [out, optional] LPCANDIDATELIST lpCandList,
  [in]            DWORD           dwBufLen
);

Параметры

unnamedParam1

[in] deIndex

Отсчитываемый от нуля индекс списка кандидатов.

[out, optional] lpCandList

Указатель на структуру CANDIDATELIST , в которой функция извлекает список кандидатов.

[in] dwBufLen

Размер (в байтах) буфера для получения списка кандидатов. Приложение может указать значение 0 для этого параметра, если функция должна возвращать только необходимый размер выходного буфера.

Возвращаемое значение

Возвращает число байтов, скопированных в буфер списка кандидатов в случае успешного выполнения. Если приложение предоставило значение 0 для параметра dwBufLen , функция возвращает размер, необходимый для буфера списка кандидатов.

Функция возвращает значение 0, если не удалось.

Заголовок imm.h определяет ImmGetCandidateList в качестве псевдонима, который автоматически выбирает версию ANSI или Юникод этой функции на основе определения константы препроцессора ЮНИКОД. Использование псевдонима, не зависящий от кодирования, с кодом, который не является нейтральным для кодировки, может привести к несоответствиям, которые приводят к ошибкам компиляции или времени выполнения. Дополнительные сведения см. в разделе Соглашения для прототипов функций.

Требования

Требование	Значение
Минимальная версия клиента	Windows XP [только классические приложения], установленная поддержка восточноазиатских языков.
Минимальная версия сервера	Windows Server 2003 [только классические приложения]
Целевая платформа	Windows
Header	imm.h (включая Immdev.h, Windows.h)
Библиотека	Imm32.lib
DLL	Imm32.dll

См. также раздел

СПИСОК КАНДИДАТОВ

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

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

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