PSGetPropertyValue 関数 (propsys.h)
プロパティ ストアからプロパティ値を取得します。
構文
PSSTDAPI PSGetPropertyValue(
[in] IPropertyStore *pps,
[in] IPropertyDescription *ppd,
[out] PROPVARIANT *ppropvar
);
パラメーター
[in] pps
種類: IPropertyStore*
値を取得するプロパティ ストアを表す IPropertyStore インターフェイスのインスタンスへのポインター。
[in] ppd
プロパティ ストア内の プロパティを表す IPropertyDescription インターフェイスのインスタンスへのポインター。
[out] ppropvar
型: PROPVARIANT*
初期化されていない PROPVARIANT 構造体へのポインター。 この関数が戻るときは、要求されたプロパティ値を指します。
戻り値
種類: HRESULT
この関数が成功すると、 S_OKが返されます。 そうでない場合は、HRESULT エラー コードを返します。
注釈
このヘルパー関数は、ストアからプロパティ値を読み取るために使用されます。 呼び出し元のコードに既に PROPERTYKEY 構造体がある場合は、 IPropertyStore::GetValue を直接呼び出す方が簡単な場合があります。
例
次の例は、大規模なプログラムの一部として含まれるように、 PSGetPropertyValue を使用する方法を示しています。
// IPropertyDescription *pPropDesc;
// IPropertyStore *pStore;
// Assume the variables pPropDesc and pStore are initialized and valid.
PROPVARIANT propvar;
HRESULT hr = PSGetPropertyValue(pStore, pPropDesc, &propvar);
if (SUCCEEDED(hr))
{
// propvar is valid.
PropVariantClear(&propvar);
}
要件
要件 | 値 |
---|---|
サポートされている最小のクライアント | WINDOWS XP と SP2、Windows Vista [デスクトップ アプリのみ] |
サポートされている最小のサーバー | Windows Server 2003 SP1 [デスクトップ アプリのみ] |
対象プラットフォーム | Windows |
ヘッダー | propsys.h |
Library | Propsys.lib |
[DLL] | Propsys.dll (バージョン 6.0 以降) |
再頒布可能パッケージ | Windows デスクトップ検索 (WDS) 3.0 |