Метод IPropertySystem::GetPropertyDescriptionListFromString (propsys.h)

Статья
01/10/2024

Возвращает экземпляр объекта подсистемы, реализующего IPropertyDescriptionList, для получения упорядоченной коллекции описаний свойств на основе предоставленной строки.

Синтаксис

HRESULT GetPropertyDescriptionListFromString(
  [in]  LPCWSTR pszPropList,
  [in]  REFIID  riid,
  [out] void    **ppv
);

Параметры

[in] pszPropList

Тип: LPCWSTR

Указатель на строку, определяющую список свойств.

[in] riid

Тип: REFIID

Ссылка на требуемый IID.

[out] ppv

Тип: void**

Адрес указателя интерфейса IPropertyDescriptionList .

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

Тип: HRESULT

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

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

Синтаксис строки списка описания свойств ("proplist") состоит из последовательности канонических имен свойств с флагами, связанными с каждым именем свойства. Строка начинается с "prop:". Синтаксис выглядит следующим образом: prop:[flags]propertyname[endflags];

Флаги являются необязательными и могут быть любым из указанных ниже. Примечание. Эти флаги переводятся в перечисление PROPDESC_VIEW_FLAGS .

Flag	Значение
-	Сортировка в обратном порядке (PDVF_REVERSESORT).
0	Отображение по умолчанию в основном и дополнительном списках (PDVF_SHOWBYDEFAULT \| PDVF_SHOWINPRIMARYLIST \| PDVF_SHOWINSECONDARYLIST).
1	Отображение в основном и дополнительном списках (PDVF_SHOWINPRIMARYLIST \| PDVF_SHOWINSECONDARYLIST).
2	Отображается в дополнительном списке (PDVF_SHOWINSECONDARYLIST).
^	Начните новую группу (PDVF_BEGINNEWGROUP).
/	Выравнивание по правому краю (PDVF_RIGHTALIGN).
*	Скрыть, если значение отсутствует.
\|	Выравнивание по центру. (PDVF_CENTERALIGN).
~	Скрыть метку. (PDVF_HIDELABEL).
#	Область заполнения. (PDVF_FILLAREA).
?	Скрыть, если обработчик свойств не поддерживается (PDVF_HIDEIFUNSUPPORTED).
<	Анализ как ссылки (PDVF_PARSEASLINK).
&	Показать как всю ссылку (PDVF_SHOWASWHOLELINK).

С точки зрения папки dbfolder и файлов:

0	Отображается как столбец в представлении defview, меню выбора столбцов и диалоговом окне выбора столбцов.
1	Отображается в меню и диалоговом окне выбора столбцов.
2	Отображается в диалоговом окне выбора столбцов.
NULL	Включите в результаты поиска, но скройте его в пользовательском интерфейсе.

Кроме того, аргументы endflags являются необязательными и могут быть следующими:

EndFlag	Значение
]	Конечный столбец (используется для представления расширенных плиток).

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

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

Требования


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

См. также раздел

IPropertySystem

Share via