PSGetPropertyKeyFromName function (propsys.h)

Gets the property key for a canonical property name.

Syntax

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

Parameters

[in] pszName

Type: PCWSTR

Pointer to a property name as a null-terminated, Unicode string.

[out] ppropkey

Type: PROPERTYKEY*

When this function returns, contains the requested property key.

Return value

Type: HRESULT

Returns one of the following values.

Remarks

Property keys uniquely identify a property. For example, PKEY_Keywords corresponds to System.Keywords. This function succeeds only for properties registered as part of the property schema.

See PSGetPropertyDescriptionByName for a list of legacy property names that are also supported by the function.

Examples

The following example, to be included as part of a larger program, demonstrates how to use PSGetPropertyKeyFromName to obtain the property key for System.Keywords.

PROPERTYKEY key;

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

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

Requirements

See also

IPropertyDescription::GetPropertyKey

PSGetNameFromPropertyKey

PSGetPropertyDescription

PSPropertyKeyFromString