Edit

ITfFnSearchCandidateProvider::SetResult method (ctffunc.h)

  • Article

Provides a text Service or IME with history data when a candidate is chosen by the user.

Syntax

HRESULT SetResult(
  [in] BSTR bstrQuery,
  [in] BSTR bstrApplicationID,
  [in] BSTR bstrResult
);

Parameters

[in] bstrQuery

The reading string for the text service or IME to convert.

[in] bstrApplicationID

App-specified string that enables a text service or IME 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.

[in] bstrResult

A string that represents the candidate string chosen by the user. It should be one of the candidate string values returned by the GetSearchCandidates method.

Return value

This method can return one of these values.

Value Description
S_OK
 The method was successful.

Remarks

Implementing and calling the SetResult method is optional.

A text service or IME can return E_PENDING if no corresponding call to GetSearchCandidates has been made yet for the value of bstrQuery.

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

GetSearchCandidates

ITfFnSearchCandidateProvider