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

Статья
03/02/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

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

[out] ppsz

Тип: LPTSTR*

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

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

Тип: HRESULT

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

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

Требования

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

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

StrRetToBuf

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