Funzione PSGetPropertyDescription (propsys.h)

  • Articolo

Ottiene un'istanza di un'interfaccia di descrizione delle proprietà per una proprietà specificata da una struttura PROPERTYKEY .

Sintassi

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

Parametri

[in] propkey

Tipo: REFPROPERTYKEY

Riferimento a UNA PROPRIETÀKEY.

[in] riid

Tipo: REFIID

Riferimento all'ID interfaccia dell'interfaccia richiesta.

[out] ppv

Tipo: void**

Quando questa funzione restituisce, contiene il puntatore dell'interfaccia richiesto in riid. Questo è in genere IPropertyDescription, IPropertyDescriptionAliasInfo o IPropertyDescriptionSearchInfo.

Valore restituito

Tipo: PSSTDAPI

Restituisce uno dei valori seguenti.

Codice restituito Descrizione
S_OK
 L'interfaccia è stata ottenuta.
E_INVALIDARG
 Il parametro ppv è NULL.
TYPE_E_ELEMENTNOTFOUND
 PROPERTYKEY non esiste nella cache del sottosistema dello schema.

Commenti

È consigliabile usare la macro IID_PPV_ARGS definita in Objbase.h per creare il pacchetto dei parametri riid e ppv . Questa macro fornisce l'IID corretto in base all'interfaccia a cui punta il valore in ppv, che elimina la possibilità di un errore di codifica.

Esempio

Nell'esempio seguente, da includere come parte di un programma più ampio, viene illustrato come usare PSGetPropertyDescription per ottenere la descrizione della proprietà per la proprietà ratings.

IPropertyDescription *pPropDesc;

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

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

Requisiti

Requisito Valore
Client minimo supportato Windows XP con SP2, Windows Vista [solo app desktop]
Server minimo supportato Windows Server 2003 con SP1 [solo app desktop]
Piattaforma di destinazione Windows
Intestazione propsys.h
Libreria Propsys.lib
DLL Propsys.dll (versione 6.0 o successiva)
Componente ridistribuibile Windows Desktop Search (WDS) 3.0

Vedi anche

PSGetPropertyDescriptionByName

PSGetPropertySystem