PSGetPropertyDescription 関数 (propsys.h)

  • [アーティクル]

PROPERTYKEY 構造体で指定されたプロパティのプロパティ記述インターフェイスのインスタンスを取得します。

構文

PSSTDAPI PSGetPropertyDescription(
  [in]  REFPROPERTYKEY propkey,
  [in]  REFIID         riid,
  [out] void           **ppv
);

パラメーター

[in] propkey

型: REFPROPERTYKEY

PROPERTYKEY への参照。

[in] riid

型: REFIID

要求されたインターフェイスのインターフェイス ID への参照。

[out] ppv

型: void**

この関数が戻るときに、 riid で要求されたインターフェイス ポインターを格納します。 これは通常、 IPropertyDescription、 IPropertyDescriptionAliasInfo、または IPropertyDescriptionSearchInfo です。

戻り値

種類: PSSTDAPI

次のいずれかの値を返します。

リターン コード 説明
S_OK
 インターフェイスが取得されました。
E_INVALIDARG
 ppv パラメーターは NULL です。
TYPE_E_ELEMENTNOTFOUND
 PROPERTYKEY はスキーマ サブシステム キャッシュに存在しません。

注釈

riid パラメーターと ppv パラメーターをパッケージ化するには、Objbase.h で定義されているIID_PPV_ARGS マクロを使用することをお勧めします。 このマクロは 、ppv の値によって指されるインターフェイスに基づいて正しい IID を提供するため、コーディング エラーが発生する可能性がなくなります。

例

大規模なプログラムの一部として含める次の例では、 PSGetPropertyDescription を 使用して ratings プロパティのプロパティの説明を取得する方法を示します。

IPropertyDescription *pPropDesc;

HRESULT hr = PSGetPropertyDescription(PKEY_Ratings, IID_PPV_ARGS(&pPropDesc));

if (SUCCEEDED(hr))
{
    // pPropDesc is now valid.
 
    pPropDesc->Release();
}

要件

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

こちらもご覧ください

PSGetPropertyDescriptionByName

PSGetPropertySystem