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 標頭會根據 UNICODE 預處理器常數的定義,將 StrRetToStr 定義為自動選取此函式的 ANSI 或 Unicode 版本。 混合使用編碼中性別名與非編碼中性的程序代碼,可能會導致編譯或運行時間錯誤不符。 如需詳細資訊,請參閱函式原型的
要求
要求 | 價值 |
---|---|
最低支援的用戶端 | Windows 2000 Professional、Windows XP [僅限傳統型應用程式] |
支援的最低伺服器 | Windows 2000 Server [僅限傳統型應用程式] |
目標平臺 | 窗戶 |
標頭 | shlwapi.h |
連結庫 | Shlwapi.lib |
DLL | Shlwapi.dll 版 (5.0 版或更新版本) |