PSEnumeratePropertyDescriptions function (propsys.h)

Article
10/13/2021

A wrapper API that calls the schema subsystem's IPropertySystem::EnumeratePropertyDescriptions. This function retrieves an instance of the subsystem object that implements IPropertyDescriptionList, to obtain either the entire list or a partial list of property descriptions in the system.

Syntax

PSSTDAPI PSEnumeratePropertyDescriptions(
  [in]  PROPDESC_ENUMFILTER filterOn,
  [in]  REFIID              riid,
  [out] void                **ppv
);

Parameters

[in] filterOn

Type: PROPDESC_ENUMFILTER

The list to return. PROPDESC_ENUMFILTER shows the valid values for this method.

[in] riid

Type: REFIID

Reference to the interface ID of the requested interface.

[out] ppv

Type: void**

The address of an IPropertyDescriptionList interface pointer.

Return value

Type: PSSTDAPI

Returns one of the following values.

Return code	Description
S_OK	Indicates an interface is obtained.
E_INVALIDARG	Indicates that ppv is NULL.

Remarks

We recommend that you use the IID_PPV_ARGS macro, defined in objbase.h, to package the riid and ppv parameters. This macro provides the correct IID based on the interface pointed to by the value in ppv, eliminating the possibility of a coding error.

Requirements

Requirement	Value
Minimum supported client	Windows XP with SP2, Windows Vista [desktop apps only]
Minimum supported server	Windows Server 2003 with SP1 [desktop apps only]
Target Platform	Windows
Header	propsys.h
Library	Propsys.lib
DLL	Propsys.dll (version 6.0 or later)
Redistributable	Windows Desktop Search (WDS) 3.0

Share via