IFolderView2::GetViewProperty method (shobjidl_core.h)

[This method is still implemented, but should be considered deprecated as of Windows 7. It might not be implemented in future versions of Windows. It cannot be used with items in search results or library views, so consider using the item's existing properties or, if applicable, emitting properties from your namespace or property handler. See Developing Property Handlers for Windows Search for more information.]

Gets a property value for a given property key from the view's cache.

Syntax

DEPRECATED_HRESULT GetViewProperty(
  PCUITEMID_CHILD pidl,
  REFPROPERTYKEY  propkey,
  PROPVARIANT     *ppropvar
);

Parameters

pidl

Type: PCUITEMID_CHILD

A pointer to an item identifier list (PIDL).

propkey

Type: REFPROPERTYKEY

The PROPERTYKEY to be retrieved.

ppropvar

Type: PROPVARIANT*

A pointer to a PROPVARIANT structure in which the PROPERTYKEY is stored.

Return value

Type: DEPRECATED_HRESULT

Returns S_OK if successful, or an error value otherwise.

Return code Description
S_OK
Success, the value is in the cache.
E_FAIL
The value is not in the view's cache.

Requirements

   
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

IFolderView2

Property Description Schema

Property Lists