Функция PSGetPropertyKeyFromName (propsys.h)

Статья
03/01/2024

Возвращает ключ свойства для канонического имени свойства.

Синтаксис

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

Параметры

[in] pszName

Тип: PCWSTR

Указатель на имя свойства в виде строки Юникода, заканчивающейся null.

[out] ppropkey

Тип: PROPERTYKEY*

При возврате этой функции содержит запрошенный ключ свойства.

Возвращаемое значение

Тип: HRESULT

Возвращает одно из следующих значений.

Код возврата	Описание
S_OK	Получена структура ключа свойства.
E_INVALIDARG	Параметр pszName имеет значение NULL.
TYPE_E_ELEMENTNOTFOUND	Каноническое имя свойства не существует в кэше подсистемы схемы.

Ключи свойств однозначно идентифицируют свойство. Например, PKEY_Keywords соответствует System.Keywords. Эта функция выполняется успешно только для свойств, зарегистрированных как часть схемы свойств.

Список устаревших имен свойств, которые также поддерживаются функцией, см. в разделе PSGetPropertyDescriptionByName .

Примеры

В следующем примере, который будет включен в более крупную программу, показано, как использовать PSGetPropertyKeyFromName для получения ключа свойства для System.Keywords.

PROPERTYKEY key;

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

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

Требования

Требование	Значение
Минимальная версия клиента	Windows XP с пакетом обновления 2 (SP2), Windows Vista [только классические приложения]
Минимальная версия сервера	Windows Server 2003 с пакетом обновления 1 (SP1) [только классические приложения]
Целевая платформа	Windows
Header	propsys.h
Библиотека	Propsys.lib
DLL	Propsys.dll (версия 6.0 или более поздняя)
Распространяемые компоненты	Windows Desktop Search (WDS) 3.0