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

Статья
08/25/2023

Возвращает экземпляр интерфейса списка описания свойств для указанного списка свойств.

Синтаксис

PSSTDAPI PSGetPropertyDescriptionListFromString(
  [in]  LPCWSTR pszPropList,
  [in]  REFIID  riid,
  [out] void    **ppv
);

Параметры

[in] pszPropList

Тип: LPCWSTR

Указатель на строку Юникода, завершающуюся null, которая идентифицирует список свойств. Дополнительные сведения о формате этого параметра см. в разделе IPropertySystem::GetPropertyDescriptionListFromString .

[in] riid

Тип: REFIID

Ссылка на идентификатор запрошенного интерфейса.

[out] ppv

Тип: void**

При возврате этой функции содержит указатель интерфейса, запрошенный в riid. Обычно это IPropertyDescriptionList.

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

Тип: PSSTDAPI

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

Код возврата	Описание
S_OK	Интерфейс получен.
E_INVALIDARG	Параметр ppv имеет значение NULL.

Эта функция вызывает реализацию подсистемы свойств IPropertySystem::GetPropertyDescriptionListFromString для получения коллекции свойств, предоставленной в виде строки списка свойств с разделителями точкой с запятой.

Мы рекомендуем использовать макрос IID_PPV_ARGS , определенный в Objbase.h, для упаковки параметров riid и ppv . Этот макрос предоставляет правильный КОД на основе интерфейса, на который указывает значение в ppv, что исключает возможность ошибки кода.

Дополнительные сведения о схемах свойств см. в разделе Схемы свойств.

Примеры

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

IPropertyDescriptionList *pList;

HRESULT hr = PSGetPropertyDescriptionListFromString(L"prop:System.Title;System.Size",
                                                    IID_PPV_ARGS(&pList));
                                                    
if (SUCCEEDED(hr))
{
    // pList is now valid.
 
    pList->Release();
}

Требования

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

Поделиться через