Funzione PSGetPropertyDescriptionByName (propsys.h)

Ottiene un'istanza di un'interfaccia di descrizione delle proprietà per un nome di proprietà specificato.

Sintassi

PSSTDAPI PSGetPropertyDescriptionByName(
  [in]  LPCWSTR pszCanonicalName,
  [in]  REFIID  riid,
  [out] void    **ppv
);

Parametri

[in] pszCanonicalName

Tipo: LPCWSTR

Puntatore a una stringa Unicode con terminazione null che identifica la proprietà.

[in] riid

Tipo: REFIID

Riferimento all'ID interfaccia della proprietà 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.

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, eliminando la possibilità di un errore di codifica.

È consigliabile che pszCanonicalName punti al nome canonico di una proprietà, ad esempio L"System.Keywords". Il nome canonico è distinzione tra maiuscole e minuscole.

Oltre ai nuovi nomi canonici, i chiamanti possono passare un nome legacy per una proprietà. La tabella seguente contiene l'elenco completo dei nomi legacy supportati e dei nomi canonici corrispondenti.

Esempio

Nell'esempio seguente, da includere come parte di un programma più ampio, viene illustrato come usare PSGetPropertyDescriptionByName per recuperare la descrizione per la proprietà rating.

IPropertyDescription *pPropDesc;

HRESULT hr = PSGetPropertyDescriptionByName(L"System.Rating", IID_PPV_ARGS(&pPropDesc))

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

Requisiti

Vedi anche

IPropertySystem

PSGetPropertyDescription