PSGetPropertyKeyFromName-Funktion (propsys.h)

Ruft den Eigenschaftenschlüssel für einen kanonischen Eigenschaftennamen ab.

Syntax

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

Parameter

[in] pszName

Typ: PCWSTR

Zeiger auf einen Eigenschaftsnamen als null-beendete Unicode-Zeichenfolge.

[out] ppropkey

Typ: PROPERTYKEY*

Wenn diese Funktion zurückgibt, enthält den angeforderten Eigenschaftenschlüssel.

Rückgabewert

Typ: HRESULT

Gibt einen der folgenden Werte zurück.

Hinweise

Eigenschaftenschlüssel identifizieren eine Eigenschaft eindeutig. PKEY_Keywords entspricht beispielsweise System.Keywords. Diese Funktion ist nur für Eigenschaften erfolgreich, die als Teil des Eigenschaftenschemas registriert sind.

Unter PSGetPropertyDescriptionByName finden Sie eine Liste der Legacyeigenschaftennamen, die auch von der Funktion unterstützt werden.

Beispiele

Im folgenden Beispiel, das als Teil eines größeren Programms eingeschlossen werden soll, wird veranschaulicht, wie Sie PSGetPropertyKeyFromName verwenden, um den Eigenschaftenschlüssel für System.Keywordsabzurufen.

PROPERTYKEY key;

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

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

Anforderungen

Weitere Informationen

IPropertyDescription::GetPropertyKey

PSGetNameFromPropertyKey

PSGetPropertyDescription

PSPropertyKeyFromString