Метод ITfFnSearchCandidateProvider::GetSearchCandidates (ctffunc.h)

Статья
08/22/2023

Возвращает список кандидатов на преобразование для заданной строки без создания сообщений или событий, связанных с IME.

Синтаксис

HRESULT GetSearchCandidates(
  [in]  BSTR             bstrQuery,
  [in]  BSTR             bstrApplicationId,
  [out] ITfCandidateList **pplist
);

Параметры

[in] bstrQuery

Строка, задающая строку чтения, которую служба текста пытается преобразовать.

[in] bstrApplicationId

Строка, указанная приложением, которая позволяет текстовой службе при необходимости предоставлять различные кандидаты для разных приложений или контекстов на основе журнала входных данных. Вы можете передать пустой BSTR, L"" для универсального контекста.

[out] pplist

ITfCandidateList, получающий запрошенные данные-кандидаты.

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

Этот метод может возвращать одно из этих значений.

Код возврата	Описание
S_OK	Метод выполнен успешно.
S_FALSE	Для входной строки не могут быть возвращены кандидаты, pplist может иметь значение NULL.

Требования

Требование	Значение
Минимальная версия клиента	Windows 8 [только классические приложения]
Минимальная версия сервера	Windows Server 2012 [только классические приложения]
Целевая платформа	Windows
Header	ctffunc.h

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

ITfFnSearchCandidateProvider

SearchPaneQueryLinguisticDetails

SetResult

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