PSGetNameFromPropertyKey-Funktion (propsys.h)

Artikel
08/08/2024

Ruft den kanonischen Namen der Eigenschaft unter Berücksichtigung ihres PROPERTYKEY ab.

Syntax

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

Parameter

[in] propkey

Typ: REFPROPERTYKEY

Verweis auf eine PROPERTYKEY-Struktur , die die angeforderte Eigenschaft identifiziert.

[out] ppszCanonicalName

Typ: PWSTR*

Wenn diese Funktion zurückgibt, enthält einen Zeiger auf den Eigenschaftennamen als unicode-Zeichenfolge mit NULL-Beendigung.

Rückgabewert

Typ: HRESULT

Gibt einen der folgenden Werte zurück.

Rückgabecode	BESCHREIBUNG
S_OK	Der kanonische Name der Eigenschaft wird abgerufen.
TYPE_E_ELEMENTNOTFOUND	Gibt an, dass der PROPERTYKEY nicht im Cache des Schemasubsystems vorhanden ist.

Hinweise

Ruft einen kanonischen Namen für einen angegebenen Eigenschaftenschlüssel ab. Wie Eigenschaftenschlüssel identifizieren kanonische Namen eine Eigenschaft eindeutig. System.Keywords Beispielsweise ist der kanonische Name für PKEY_Keywords. Diese Funktion ist nur für Eigenschaften erfolgreich, die als Teil des Eigenschaftenschemas registriert sind.

Es liegt in der Verantwortung der aufrufenden Anwendung , CoTaskMemFree zu verwenden, um die von ppszCanonicalName erwähnte Zeichenfolge freizugeben, wenn sie nicht mehr benötigt wird.

Beispiele

Im folgenden Beispiel, das als Teil eines größeren Programms eingeschlossen werden soll, wird veranschaulicht, wie Sie PSGetNameFromPropertyKey verwenden, um einen Wert aus dem serialisierten Eigenschaftenspeicher zu lesen.

PWSTR pszName;

HRESULT hr = PSGetNameFromPropertyKey(PKEY_Keywords, &pszName);

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

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

IPropertyDescription::GetCanonicalName

PSGetPropertyDescriptionByName

PSGetPropertyKeyFromName

PSStringFromPropertyKey

Freigeben über