ITfFnSearchCandidateProvider::GetSearchCandidates メソッド (ctffunc.h)

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 である可能性があります。