StrRetToBufW 函式 (shlwapi.h)
將 IShellFolder::GetDisplayNameOf 傳回的 STRRET 結構轉換成字串,並將結果放在緩衝區中。
語法
LWSTDAPI StrRetToBufW(
[in, out] STRRET *pstr,
[in] PCUITEMID_CHILD pidl,
[out] LPWSTR pszBuf,
[in] UINT cchBuf
);
參數
[in, out] pstr
類型: STRRET*
STRRET 結構的指標。 當函式傳回時,此指標將不再有效。
[in] pidl
類型: PCUITEMID_CHILD
專案的 ITEMIDLIST 結構的指標。
[out] pszBuf
類型: LPTSTR
要保存顯示名稱的緩衝區。 它會以 Null 終止的字串的形式傳回。 如果 cchBuf 太小,則會截斷名稱以符合。
[in] cchBuf
類型: UINT
pszBuf 的大小,以字元為單位。 如果 cchBuf 太小,字串將會截斷以符合。
傳回值
類型: HRESULT
如果此函式成功,則會傳回 S_OK。 否則,它會傳回 HRESULT 錯誤碼。
備註
如果 pstr 所指向結構的 uType 成員設定為STRRET_WSTR,則會在傳回時釋放該結構的 pOleStr 成員。
注意
shlwapi.h 標頭會將 StrRetToBuf 定義為別名,根據 UNICODE 預處理器常數的定義,自動選取此函式的 ANSI 或 Unicode 版本。 混合使用編碼中性別名與非編碼中性的程序代碼,可能會導致編譯或運行時間錯誤不符。 如需詳細資訊,請參閱 函式原型的慣例。
規格需求
需求 | 值 |
---|---|
最低支援的用戶端 | Windows 2000 專業版、Windows XP [僅限傳統型應用程式] |
最低支援的伺服器 | Windows 2000 Server [僅限傳統型應用程式] |
目標平台 | Windows |
標頭 | shlwapi.h |
程式庫 | Shlwapi.lib |
Dll | Shlwapi.dll (5.0 版或更新版本) |