Поделиться через


Функция StrRetToBSTR (shlwapi.h)

Принимает структуру STRRET , возвращенную IShellFolder::GetDisplayNameOf , которая содержит строку или указывает на нее, и возвращает эту строку в виде BSTR.

Синтаксис

LWSTDAPI StrRetToBSTR(
  [in, out] STRRET          *pstr,
  [in]      PCUITEMID_CHILD pidl,
  [out]     BSTR            *pbstr
);

Параметры

[in, out] pstr

Тип: STRRET*

Указатель на структуру STRRET . При возврате функции этот указатель становится более допустимым.

[in] pidl

Тип: PCUITEMID_CHILD

Указатель на ITEMIDLIST , однозначно определяющий объект файла или вложенную папку относительно родительской папки. Это значение может иметь значение NULL.

[out] pbstr

Тип: BSTR*

Указатель на переменную типа BSTR , которая получает преобразованную строку.

Возвращаемое значение

Тип: HRESULT

Если эта функция завершается успешно, она возвращает S_OK. В противном случае возвращается код ошибки HRESULT .

Комментарии

Если элемент uType структуры STRRET , на который указывает pstr , имеет значение STRRET_WSTR, то элемент pOleStr этой структуры освобождается при возврате.

Требования

Требование Значение
Минимальная версия клиента Windows XP [только классические приложения]
Минимальная версия сервера Windows Server 2003 [только классические приложения]
Целевая платформа Windows
Header shlwapi.h
Библиотека Shlwapi.lib
DLL Shlwapi.dll (версия 5.5 или более поздняя)

См. также раздел

IShellFolder::GetDisplayNameOf

StrRetToBuf

StrRetToStr