Funzione PSGetNameFromPropertyKey (propsys.h)

Recupera il nome canonico della proprietà, in base alla proprietà PROPERTYKEY.

Sintassi

PSSTDAPI PSGetNameFromPropertyKey(
  [in]  REFPROPERTYKEY propkey,
  [out] PWSTR          *ppszCanonicalName
);

Parametri

[in] propkey

Tipo: REFPROPERTYKEY

Riferimento a una struttura PROPERTYKEY che identifica la proprietà richiesta.

[out] ppszCanonicalName

Tipo: PWSTR*

Quando questa funzione viene restituita, contiene un puntatore al nome della proprietà come stringa Unicode con terminazione Null.

Valore restituito

Tipo: HRESULT

Restituisce uno dei valori seguenti.

Commenti

Recupera un nome canonico per una chiave di proprietà specificata. Come le chiavi di proprietà, i nomi canonici identificano in modo univoco una proprietà. Ad esempio, System.Keywords è il nome canonico per PKEY_Keywords. Questa funzione ha esito positivo solo per le proprietà registrate come parte dello schema delle proprietà.

È responsabilità dell'applicazione chiamante usare CoTaskMemFree per rilasciare la stringa a cui fa riferimento ppszCanonicalName quando non è più necessaria.

Esempio

Nell'esempio seguente, da includere come parte di un programma più ampio, viene illustrato come usare PSGetNameFromPropertyKey per leggere un valore dall'archiviazione delle proprietà serializzate.

PWSTR pszName;

HRESULT hr = PSGetNameFromPropertyKey(PKEY_Keywords, &pszName);

if (SUCCEEDED(hr))
{
    // pszName now contains L"System.Keywords"
 
    CoTaskMemFree(pszName);
}

Requisiti

Vedi anche

IPropertyDescription::GetCanonicalName

PSGetPropertyDescriptionByName

PSGetPropertyKeyFromName

PSStringFromPropertyKey