ITfProperty::SetValue メソッド (msctf.h)

範囲の プロパティの値を設定します。

構文

HRESULT SetValue(
  [in] TfEditCookie  ec,
  [in] ITfRange      *pRange,
  [in] const VARIANT *pvarValue
);

パラメーター

[in] ec

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

[in] pRange

プロパティ値が設定されている範囲を含む ITfRange インターフェイスへのポインター。 このパラメーターを NULL にすることはできません。 pRange が空の場合、このメソッドは失敗します。

[in] pvarValue

新しいプロパティ値を含む VARIANT 構造体へのポインター。 型VT_I4、VT_UNKNOWN、VT_BSTR、VT_EMPTYの値のみがサポートされます。

戻り値

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

説明
S_OK
メソッドは正常に実行されました。
E_INVALIDARG
1 つ以上のパラメーターが無効です。
E_OUTOFMEMORY
メモリ割り当てエラーが発生しました。
E_FAIL
未指定のエラーが発生しました。
TF_E_NOLOCK
ec によって識別される編集コンテキストには、読み取り/書き込みロックがありません。
TF_E_READONLY
編集コンテキストは読み取り専用です。
TF_E_NOTOWNEDRANGE
TSF マネージャーは範囲を所有していません。

注釈

このメソッドで設定されたプロパティ値は、プロパティ値がカバーするテキストが変更されると破棄されます。 テキスト編集に対する値の応答をカスタムで制御するには、 ITfProperty::SetValueStore を使用します。

このメソッドで設定された値は、シリアル化されない型VT_UNKNOWNの値を除き、シリアル化されます。 VT_UNKNOWN型のプロパティ値をシリアル化する必要がある場合は、代わりに ITfProperty::SetValueStore を 使用します。

同じ型の重複するプロパティ値はサポートされていません。

要件

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

こちらもご覧ください

ITfDocumentMgr::CreateContext

ITfEditSession::D oEditSession

ITfProperty

ITfProperty::SetValueStore

ITfRange