SHGetNameFromIDList 函式 (shobjidl_core.h)

  • 發行項

擷取其IDList所識別項目的顯示名稱。

語法

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

參數

[in] pidl

類型： PCIDLIST_ABSOLUTE

識別專案的 PIDL。

[in] sigdnName

類型： SIGDN

SIGDN 列舉中的值，指定要擷取的顯示名稱類型。

[out] ppszName

類型： PWSTR*

值，當此函式成功傳回時，會收到所擷取顯示名稱之指標的位址。

傳回值

類型： HRESULT

如果此函式成功，則會傳回 S_OK。 否則，它會傳回 HRESULT 錯誤碼。

備註

呼叫者在不再需要時，必須負責釋出 ppszName 所指向的字串。 在 *ppszName 上呼叫 CoTaskMemFree 以釋放記憶體。

規格需求

需求 值
最低支援的用戶端 Windows Vista [僅限傳統型應用程式]
最低支援的伺服器 Windows Server 2008 [僅限傳統型應用程式]
目標平台 Windows
標頭 shobjidl_core.h (包括 Shobjidl.h)
Dll Shell32.dll