ITfContextComposition::StartComposition メソッド (msctf.h)

  • [アーティクル]

新しいコンポジションを作成します。

構文

HRESULT StartComposition(
  [in]  TfEditCookie       ecWrite,
  [in]  ITfRange           *pCompositionRange,
  [in]  ITfCompositionSink *pSink,
  [out] ITfComposition     **ppComposition
);

パラメーター

[in] ecWrite

編集コンテキストを識別する編集 Cookie が含まれます。 これは 、ITfEditSession::D oEditSession から取得されます。

[in] pCompositionRange

コンポジションが最初にカバーするテキストを指定する ITfRange オブジェクトへのポインター。

[in] pSink

コンポジション イベント通知を受け取る ITfCompositionSink オブジェクトへのポインター。 このパラメーターは省略可能であり、 NULL にすることができます。 指定した場合、コンポジションが終了するとオブジェクトが解放されます。

[out] ppComposition

新しいコンポジション オブジェクトを受け取る ITfComposition インターフェイス ポインターへのポインター。 コンテキスト所有者がコンポジションを拒否した場合、このパラメーターは NULL を 受け取ります。

戻り値

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

値 説明
S_OK
 メソッドは正常に実行されました。 コンテキスト所有者コンポジションがシンクにコンポジションを拒否するようアドバイスする場合、 ppComposition は NULL に設定されます。
E_FAIL
 未指定のエラーが発生しました。
E_INVALIDARG
 1 つ以上のパラメーターが無効です。
E_OUTOFMEMORY
 コンポジション オブジェクトを作成できません。
E_UNEXPECTED
 メソッドは、別のコンポジション操作内で呼び出されました。
TF_E_DISCONNECTED
 コンテキスト オブジェクトがドキュメント スタック上にありません。
TF_E_NOLOCK
 ecWrite によって識別される編集コンテキストには、読み取り/書き込みロックがありません。

解説

コンテキスト所有者がコンテキスト所有者コンポジションをインストールしてシンクにアドバイスした場合、 ITfContextOwnerCompositionSink::OnStartComposition メソッドが呼び出されます。 アドバイズ シンクが新しいコンポジションを拒否した場合、このメソッドは S_OKを返しますが、 ppComposition は NULL に設定されます。

pCompositionRange の対象となるテキストは、GUID_PROP_COMPOSING プロパティを受け取ります。

要件

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

関連項目

IEnumITfCompositionView インターフェイス、 ITfContextComposition インターフェイス、 ITfRange インターフェイス、 ITfCompositionSink インターフェイス、 ITfContextOwnerCompositionSink::OnStartComposition、 ITfEditSession::D oEditSession