SHGetNameFromIDList function (shobjidl_core.h)

Article
2024-02-22

Retrieves the display name of an item identified by its IDList.

Syntax

SHSTDAPI SHGetNameFromIDList(
  [in]  PCIDLIST_ABSOLUTE pidl,
  [in]  SIGDN             sigdnName,
  [out] PWSTR             *ppszName
);

Parameters

[in] pidl

Type: PCIDLIST_ABSOLUTE

A PIDL that identifies the item.

[in] sigdnName

Type: SIGDN

A value from the SIGDN enumeration that specifies the type of display name to retrieve.

[out] ppszName

Type: PWSTR*

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 function 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

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)
DLL	Shell32.dll

Share via