Edit

Share via

IShellImageData::DisplayName method (shimgdata.h)

  • Article

Gets the name of the file if IShellImageData was initialized on a file path. Otherwise, gets the name of the data stream.

Syntax

HRESULT DisplayName(
  [in, out] LPWSTR wszName,
  [in]      UINT   cch
);

Parameters

[in, out] wszName

Type: LPWSTR

A pointer to a buffer containing the display name as a Unicode string. On exit, the contents of the buffer are only valid when the method returns S_OK.

[in] cch

Type: UINT

The size, in characters, of the buffer pointed to by wszName.

Return value

Type: HRESULT

Returns S_OK if successful or an error value otherwise, including the following:

Return code Description
E_FAIL
 The file name or stream name cannot be retrieved.

Requirements

Requirement Value
Minimum supported client Windows XP [desktop apps only]
Minimum supported server Windows Server 2003 [desktop apps only]
Target Platform Windows
Header shimgdata.h
DLL Shell32.dll