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

Статья
11/20/2024

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

Синтаксис

LWSTDAPI StrRetToStrA(
  [in, out]      STRRET          *pstr,
  [in, optional] PCUITEMID_CHILD pidl,
  [out]          LPSTR           *ppsz
);

Параметры

[in, out] pstr

Тип: STRRET*

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

[in, optional] pidl

Тип: PCUITEMID_CHILD

Указатель на структуру ITEMID LIST элемента. Это значение может быть NULL.

[out] ppsz

Тип: LPTSTR*

Указатель на выделенную строку, содержащую результат. StrRetToStr выделяет память для этой строки с CoTaskMemAlloc. Вы должны освободить строку с CoTaskMemFree, если она больше не нужна.

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

Тип: HRESULT

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

Замечания

Заметка

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

Требования

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

См. также

StrRetToBuf

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