StrRetToBufA 函数 (shlwapi.h)

将 IShellFolder：：GetDisplayNameOf 返回的 STRRET 结构转换为字符串，并将结果置于缓冲区中。

语法

LWSTDAPI StrRetToBufA(
  [in, out] STRRET          *pstr,
  [in]      PCUITEMID_CHILD pidl,
  [out]     LPSTR           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
Library	Shlwapi.lib
DLL	Shlwapi.dll (5.0 或更高版本)

另请参阅

StrRetToStr

StrRetToStrN