IShellItemResources::GetResourceDescription method (shobjidl_core.h)

Gets a resource description.

Syntax

HRESULT GetResourceDescription(
        const SHELL_ITEM_RESOURCE *pcsir,
  [out] LPWSTR                    *ppszDescription
);

Parameters

pcsir

Type: const SHELL_ITEM_RESOURCE*

A pointer to a SHELL_ITEM_RESOURCE resource.

[out] ppszDescription

Type: LPWSTR*

A pointer to a resource description as a Unicode string.

Return value

Type: HRESULT

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

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)