IShellItem::GetDisplayName method (shobjidl_core.h)

Gets the display name of the IShellItem object.

Syntax

HRESULT GetDisplayName(
  [in]  SIGDN  sigdnName,
  [out] LPWSTR *ppszName
);

Parameters

[in] sigdnName

Type: SIGDN

One of the SIGDN values that indicates how the name should look.

[out] ppszName

Type: LPWSTR*

A value that, when this function returns successfully, receives the address of a pointer to the retrieved display name.

Return value

Type: HRESULT

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

Remarks

It is the responsibility of the caller to free the string pointed to by ppszName when it is no longer needed. Call CoTaskMemFree on *ppszName to free the memory.

Requirements

   
Minimum supported client Windows XP with SP1 [desktop apps only]
Minimum supported server Windows Server 2003 [desktop apps only]
Target Platform Windows
Header shobjidl_core.h (include Shlguid.h)
DLL Shell32.dll (version 5.00 or later)

See also

IShellFolder

IShellItem