Функция StrRetToBufA (shlwapi.h)
Преобразует структуру 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
Указатель на структуру ITEMIDLIST элемента.
[out] pszBuf
Тип: LPTSTR
Буфер для хранения отображаемого имени. Он будет возвращен в виде строки, заканчивающейся нулевым значением. Если cchBuf слишком мал, имя будет усечено.
[in] cchBuf
Тип: UINT
Размер pszBuf в символах. Если cchBuf слишком мал, строка будет усечена в соответствии с размером.
Возвращаемое значение
Тип: HRESULT
Если эта функция завершается успешно, она возвращает S_OK. В противном случае возвращается код ошибки HRESULT .
Комментарии
Если элемент uType структуры, на который указывает pstr , имеет значение STRRET_WSTR, элемент pOleStr этой структуры будет освобожден при возврате.
Примечание
Заголовок shlwapi.h определяет StrRetToBuf в качестве псевдонима, который автоматически выбирает версию ANSI или Юникод этой функции на основе определения константы препроцессора ЮНИКОД. Использование псевдонима, не зависящий от кодирования, с кодом, который не является нейтральным для кодировки, может привести к несоответствиям, которые приводят к ошибкам компиляции или времени выполнения. Дополнительные сведения см. в разделе Соглашения для прототипов функций.
Требования
Требование | Значение |
---|---|
Минимальная версия клиента | Windows 2000 Professional, Windows XP [только классические приложения] |
Минимальная версия сервера | Windows 2000 Server [только классические приложения] |
Целевая платформа | Windows |
Header | shlwapi.h |
Библиотека | Shlwapi.lib |
DLL | Shlwapi.dll (версия 5.0 или более поздняя) |