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 [仅限桌面应用]
目标平台 窗户
标头 shlwapi.h
Shlwapi.lib
DLL Shlwapi.dll (版本 5.0 或更高版本)

另请参阅

StrRetToBuf