Edit

Share via

ITfFnSearchCandidateProvider::GetSearchCandidates method (ctffunc.h)

  • Article

Gets a list of conversion candidates for a given string without generating any IME-related messages or events.

Syntax

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

Parameters

[in] bstrQuery

A string that specifies the reading string that the text service attempts to convert.

[in] bstrApplicationId

App-specified string that enables a text service to optionally provide different candidates to different apps or contexts based on input history. You can pass an empty BSTR, L””, for a generic context.

[out] pplist

An ITfCandidateList that receives the requested candidate data.

Return value

This method can return one of these values.

Return code Description
S_OK
 The method was successful.
S_FALSE
 No candidates could be returned for the input string, pplist may be NULL.

Requirements

Requirement Value
Minimum supported client Windows 8 [desktop apps only]
Minimum supported server Windows Server 2012 [desktop apps only]
Target Platform Windows
Header ctffunc.h

See also

ITfFnSearchCandidateProvider

SearchPaneQueryLinguisticDetails

SetResult