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 专业版、Windows XP [仅限桌面应用]
最低受支持的服务器 Windows 2000 Server [仅限桌面应用]
目标平台 Windows
标头 shlwapi.h
Library Shlwapi.lib
DLL Shlwapi.dll (5.0 或更高版本)

另请参阅

StrRetToBuf