PSGetPropertyDescription-Funktion (propsys.h)

  • Artikel

Ruft eine instance einer Eigenschaftenbeschreibungsschnittstelle für eine Eigenschaft ab, die von einer PROPERTYKEY-Struktur angegeben wird.

Syntax

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

Parameter

[in] propkey

Typ: REFPROPERTYKEY

Verweis auf einen PROPERTYKEY.

[in] riid

Typ: REFIID

Verweis auf die Schnittstellen-ID der angeforderten Schnittstelle.

[out] ppv

Typ: void**

Wenn diese Funktion zurückgibt, enthält den in riid angeforderten Schnittstellenzeiger. Dies ist in der Regel IPropertyDescription, IPropertyDescriptionAliasInfo oder IPropertyDescriptionSearchInfo.

Rückgabewert

Typ: PSSTDAPI

Gibt einen der folgenden Werte zurück.

Rückgabecode BESCHREIBUNG
S_OK
 Die Schnittstelle wurde abgerufen.
E_INVALIDARG
 Der ppv-Parameter ist NULL.
TYPE_E_ELEMENTNOTFOUND
 Der PROPERTYKEY ist im Cache des Schemasubsystems nicht vorhanden.

Hinweise

Es wird empfohlen, das makro IID_PPV_ARGS zu verwenden, das in Objbase.h definiert ist, um die Parameter riid und ppv zu packen. Dieses Makro stellt die richtige IID basierend auf der Schnittstelle bereit, auf die der Wert in ppv verweist, wodurch die Möglichkeit eines Codierungsfehlers ausgeschlossen wird.

Beispiele

Im folgenden Beispiel, das als Teil eines größeren Programms eingeschlossen werden soll, wird veranschaulicht, wie PSGetPropertyDescription verwendet wird, um die Eigenschaftenbeschreibung für die Bewertungseigenschaft abzurufen.

IPropertyDescription *pPropDesc;

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

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

Anforderungen

Anforderung Wert
Unterstützte Mindestversion (Client) Windows XP mit SP2, Windows Vista [nur Desktop-Apps]
Unterstützte Mindestversion (Server) Windows Server 2003 mit SP1 [nur Desktop-Apps]
Zielplattform Windows
Kopfzeile propsys.h
Bibliothek Propsys.lib
DLL Propsys.dll (Version 6.0 oder höher)
Verteilbare Komponente Windows Desktop Search (WDS) 3.0

Weitere Informationen

PSGetPropertyDescriptionByName

PSGetPropertySystem