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

Статья
11/20/2024

Преобразует структуру STRRET, возвращаемую IShellFolder::GetDisplayNameOf в строку, и помещает результат в буфер.

Синтаксис

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

Указатель на структуру ITEMID LIST элемента.

[out] pszBuf

Тип: LPTSTR

Буфер для хранения отображаемого имени. Он будет возвращен в виде строки, завершающейся значением NULL. Если cchBuf слишком мал, имя будет усечено для соответствия.

[in] cchBuf

Тип: UINT

Размер pszBufв символах. Если cchBuf слишком мал, строка будет усечена для соответствия.

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

Тип: HRESULT

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

Замечания

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

Заметка

Заголовок shlwapi.h определяет StrRetToBuf как псевдоним, который автоматически выбирает версию ANSI или Юникод этой функции на основе определения константы препроцессора ЮНИКОДа. Сочетание использования псевдонима, нейтрального для кодирования, с кодом, не зависящим от кодирования, может привести к несоответствиям, которые приводят к ошибкам компиляции или среды выполнения. Дополнительные сведения см. в соглашениях о прототипах функций.

Требования

Требование	Ценность
минимальные поддерживаемые клиентские	Windows 2000 Профессиональный, Windows XP [только классические приложения]
минимальный поддерживаемый сервер	Windows 2000 Server [только классические приложения]
целевая платформа	Виндоус
заголовка	shlwapi.h
библиотеки	Shlwapi.lib
DLL	Shlwapi.dll (версия 5.0 или более поздняя версия)

См. также

StrRetToStr

StrRetToStrN

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