Edit

IShellItemArray::GetPropertyDescriptionList method (shobjidl_core.h)

  • Article

Gets a property description list for the items in the shell item array.

Syntax

HRESULT GetPropertyDescriptionList(
  [in]  REFPROPERTYKEY keyType,
  [in]  REFIID         riid,
  [out] void           **ppv
);

Parameters

[in] keyType

Type: REFPROPERTYKEY

A reference to the PROPERTYKEY structure specifying which property list to retrieve.

[in] riid

Type: REFIID

The IID of the object type to retrieve.

[out] ppv

Type: void**

When this method returns, contains the interface requested in riid. This will typically be IPropertyDescriptionList.

Return value

Type: HRESULT

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

This function is used to determine a list of properties that are applicable to a set of shell items. The type of list is specified by a PROPERTYKEY structure. Supported list types include but are not limited to:

  • PKEY_PropList_PreviewDetails
  • PKEY_PropList_PreviewTitle
  • PKEY_PropList_FullDetails
  • PKEY_PropList_TileInfo
  • PKEY_PropList_ExtendedTileInfo
  • PKEY_PropList_InfoTip
  • PKEY_PropList_QuickTip
  • PKEY_PropList_FileOperationPrompt
  • PKEY_PropList_ConflictPrompt
  • PKEY_PropList_SetDefaultsFor
  • PKEY_PropList_NonPersonal
  • PKEY_NewMenuPreferredTypes
  • PKEY_NewMenuAllowedTypes
If the shell item array contains more than one item, then this method will obtain an intersection of the properties that would be returned for each item individually.

Requirements

Requirement Value
Minimum supported client Windows Vista [desktop apps only]
Minimum supported server Windows Server 2008 [desktop apps only]
Target Platform Windows
Header shobjidl_core.h (include Shobjidl.h)

See also

IShellItemArray

Property Lists