strRetToStrA 函式 (shlwapi.h)

  • 發行項

接受 IShellFolder：：GetDisplayNameOf 所傳回的 STRRET 結構，並傳回包含顯示名稱之已配置字串的指標。

語法

LWSTDAPI StrRetToStrA(
  [in, out]      STRRET          *pstr,
  [in, optional] PCUITEMID_CHILD pidl,
  [out]          LPSTR           *ppsz
);

參數

[in, out] pstr

類型： STRRET*

STRRET 結構的指標。 當函式傳回時，此指標將不再有效。

[in, optional] pidl

類型： PCUITEMID_CHILD

專案 ITEMIDLIST 結構的指標。 此值可以是 NULL。

[out] ppsz

類型： LPTSTR*

包含結果之已配置字串的指標。 StrRetToStr 會使用 CoTaskMemAlloc 配置此字串的記憶體。 當不再需要字串時，您應該使用 CoTaskMemFree 釋放字串。

傳回值

類型： HRESULT

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

備註

注意

shlwapi.h 標頭會將 StrRetToStr 定義為別名，根據 UNICODE 預處理器常數的定義，自動選取此函式的 ANSI 或 Unicode 版本。 混合使用編碼中性別名與非編碼中性的程序代碼，可能會導致編譯或運行時間錯誤不符。 如需詳細資訊，請參閱 函式原型的慣例。

規格需求

需求 值
最低支援的用戶端 Windows 2000 Professional、Windows XP [僅限桌面應用程式]
最低支援的伺服器 Windows 2000 Server [僅限桌面應用程式]
目標平台 Windows
標頭 shlwapi.h
程式庫 Shlwapi.lib
Dll Shlwapi.dll (5.0 版或更新版本)

另請參閱

StrRetToBuf