ITfCandidateList::SetResult メソッド (ctffunc.h)

特定の候補文字列の再変換操作の結果を指定します。

構文

HRESULT SetResult(
  [in] ULONG             nIndex,
  [in] TfCandidateResult imcr
);

[in] nIndex

結果を設定する候補文字列の 0 から始まるインデックスを指定します。 imcr にCAND_CANCELEDが含まれている場合、このパラメーターは無視されます。

[in] imcr

再変換操作の結果を指定する TfCandidateResult 値のいずれかが含まれています。

このメソッドは、これらの値のいずれかを返すことができます。

値	説明
S_OK	メソッドは正常に実行されました。
E_FAIL	未指定のエラーが発生しました。

一般的な再変換操作には、次の操作が含まれます。

候補の一覧が取得され、ダイアログボックスにユーザーに表示されます。
ユーザーが候補を選択したが、ダイアログボックスが閉じる前に、新しく選択した候補のインデックスと共に ITfCandidateList::SetResult が呼び出され、CAND_SELECTED。
別の候補が選択されている場合、 ITfCandidateList::SetResult が再び呼び出され、新しく選択された候補とCAND_SELECTEDのインデックスが付きます。
ユーザーが新しい候補を受け入れることを選択した場合、 ITfCandidateList::SetResult が現在選択されている候補のインデックスと共に呼び出され、CAND_FINALIZED。
ユーザーがダイアログを取り消すと、 ITfCandidateList::SetResult が 0 のインデックスとCAND_CANCELEDで呼び出されます。

要件	値
サポートされている最小のクライアント	Windows 2000 Professional [デスクトップアプリ \|UWP アプリ]
サポートされている最小のサーバー	Windows 2000 Server [デスクトップアプリ \|UWP アプリ]
対象プラットフォーム	Windows
ヘッダー	ctffunc.h
[DLL]	Tiptsf.dll
再頒布可能パッケージ	Windows 2000 Professional の TSF 1.0