Edit

Share via

IPropertySystem::EnumeratePropertyDescriptions method (propsys.h)

  • Article

Gets an instance of the subsystem object that implements IPropertyDescriptionList, to obtain either the entire or a partial list of property descriptions in the system.

Syntax

HRESULT EnumeratePropertyDescriptions(
  [in]  PROPDESC_ENUMFILTER filterOn,
  [in]  REFIID              riid,
  [out] void                **ppv
);

Parameters

[in] filterOn

Type: PROPDESC_ENUMFILTER

The list to return. See PROPDESC_ENUMFILTER. Valid values for this method are 0 through 4.

[in] riid

Type: REFIID

A reference to the desired IID.

[out] ppv

Type: void**

The address of an IPropertyDescriptionList interface pointer.

Return value

Type: HRESULT

Returns one of the following values.

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

Remarks

This method is not implemented where BUILDING_DOWNLEVEL_LIB is defined.

It is recommended 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
DLL Propsys.dll (version 5.0 or later)
Redistributable Windows Desktop Search (WDS) 3.0

See also

IPropertySystem