PSSetPropertyValue 関数 (propsys.h)

プロパティ ストア内のプロパティの値を設定します。

構文

PSSTDAPI PSSetPropertyValue(
  [in] IPropertyStore       *pps,
  [in] IPropertyDescription *ppd,
  [in] REFPROPVARIANT       propvar
);

パラメーター

[in] pps

種類: IPropertyStore*

プロパティを含むプロパティ ストアを表す IPropertyStore インターフェイスのインスタンスへのポインター。

[in] ppd

型: IPropertyDescription*

個々のプロパティを識別する IPropertyDescription インターフェイスのインスタンスへのポインター。

[in] propvar

型: REFPROPVARIANT

新しい値を含む PROPVARIANT 構造体への参照。

戻り値

型: HRESULT

この関数が成功すると、 S_OKが返されます。 そうでない場合は、HRESULT エラー コードを返します。

注釈

このヘルパー関数は、プロパティ値をストアに書き込むのに使用されます。 呼び出し元のコードに PROPERTYKEY 構造体が既にある場合は、 IPropertyStore::SetValue を直接呼び出す方が簡単な場合があります。

例

大規模なプログラムの一部として含める次の例では、 PSSetPropertyValue を使用する方法を示します。

// IPropertyDescription *pPropDesc;
// IPropertyStore *pStore;
// PROPVARIANT propvar;
// Assume the variables pStore, pPropDesc, and propvar are initialized and valid.

HRESULT hr = PSSetPropertyValue(pStore, pPropDesc, propvar);

if (SUCCEEDED(hr))
{
    // The value has been written to the store but has not been committed yet.
}

要件

要件	値
サポートされている最小のクライアント	WINDOWS XP と SP2、Windows Vista [デスクトップ アプリのみ]
サポートされている最小のサーバー	Windows Server 2003 SP1 [デスクトップ アプリのみ]
対象プラットフォーム	Windows
ヘッダー	propsys.h
Library	Propsys.lib
[DLL]	Propsys.dll (バージョン 6.0 以降)
再頒布可能パッケージ	Windows デスクトップ検索 (WDS) 3.0

こちらもご覧ください

IPropertyStore::Commit

PSGetPropertyValue