ITfFnSearchCandidateProvider::GetSearchCandidates method

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

bstrQuery [in]

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

bstrApplicationId [in]

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.

pplist [out]

An ITfCandidateList that receives the requested candidate data.

Return value

This method can return one of these values.

Return codeDescription
S_OK

The method was successful.

S_FALSE

No candidates could be returned for the input string, pplist may be NULL.

 

Requirements

Minimum supported client

Windows 8 [desktop apps only]

Minimum supported server

Windows Server 2012 [desktop apps only]

Header

Ctffunc.h

IDL

Ctffunc.idl

See also

ITfFnSearchCandidateProvider
SetResult
SearchPaneQueryLinguisticDetails

 

 

Community Additions

ADD
Show:
© 2014 Microsoft