Funzione PSGetPropertyKeyFromName (propsys.h)

Articolo
08/25/2023

Ottiene la chiave della proprietà per un nome di proprietà canonico.

Sintassi

PSSTDAPI PSGetPropertyKeyFromName(
  [in]  PCWSTR      pszName,
  [out] PROPERTYKEY *ppropkey
);

Parametri

[in] pszName

Tipo: PCWSTR

Puntatore a un nome di proprietà come stringa Unicode con terminazione Null.

[out] ppropkey

Tipo: PROPERTYKEY*

Quando questa funzione viene restituita, contiene la chiave della proprietà richiesta.

Valore restituito

Tipo: HRESULT

Restituisce uno dei valori seguenti.

Codice restituito	Descrizione
S_OK	La struttura della chiave della proprietà è stata ottenuta.
E_INVALIDARG	Il parametro pszName è NULL.
TYPE_E_ELEMENTNOTFOUND	Il nome della proprietà canonica non esiste nella cache del sottosistema dello schema.

Commenti

Le chiavi di proprietà identificano in modo univoco una proprietà. Ad esempio, PKEY_Keywords corrisponde a System.Keywords. Questa funzione ha esito positivo solo per le proprietà registrate come parte dello schema delle proprietà.

Per un elenco di nomi di proprietà legacy supportati dalla funzione, vedere PSGetPropertyDescriptionByName .

Esempio

Nell'esempio seguente, da includere come parte di un programma più ampio, viene illustrato come usare PSGetPropertyKeyFromName per ottenere la chiave della proprietà per System.Keywords.

PROPERTYKEY key;

HRESULT hr = PSGetPropertyKeyFromName(L"System.Keywords", &key);

if (SUCCEEDED(hr))
{
    // The property key is now valid.
}

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