Функция ImmGetCandidateListW (immdev.h)
Извлекает список кандидатов.
Синтаксис
DWORD ImmGetCandidateListW(
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, если она не выполнена.
Замечания
Заметка
Заголовок immdev.h определяет ImmGetCandidateList как псевдоним, который автоматически выбирает версию ANSI или Юникод этой функции на основе определения константы препроцессора ЮНИКОДа. Сочетание использования псевдонима, нейтрального для кодирования, с кодом, не зависящим от кодирования, может привести к несоответствиям, которые приводят к ошибкам компиляции или среды выполнения. Дополнительные сведения см. в соглашениях о прототипах функций.
Требования
Требование | Ценность |
---|---|
минимальные поддерживаемые клиентские | Windows XP [только классические приложения], установленная поддержка языка Восточной Азии. |
минимальный поддерживаемый сервер | Windows Server 2003 [только классические приложения] |
целевая платформа | Виндоус |
заголовка | immdev.h (include Immdev.h, Windows.h) |
библиотеки |
Imm32.lib |
DLL | Imm32.dll |
См. также
КАНДИДАТОВ
Функции диспетчера методов ввода