Функция SHQueryRecycleBinA (shellapi.h)

Статья
11/20/2024

Извлекает размер корзины и количество элементов в нем для указанного диска.

Синтаксис

SHSTDAPI SHQueryRecycleBinA(
  [in, optional] LPCSTR          pszRootPath,
  [in, out]      LPSHQUERYRBINFO pSHQueryRBInfo
);

Параметры

[in, optional] pszRootPath

Тип: LPCTSTR

Адрес null-завершенной строки максимальной длины MAX_PATH, чтобы содержать путь корневого диска, на котором находится корзина. Этот параметр может содержать адрес строки, форматируемой с именами дисков, папок и вложенных папок (C:\Windows\System...).

[in, out] pSHQueryRBInfo

Тип: LPSHQUERYRBINFO

Адрес структуры SHQUERYRBINFO, которая получает сведения о корзине. Перед вызовом этого API необходимо задать cbSize член структуры.

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

Тип: HRESULT

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

Замечания

При использовании Windows 2000, если NULL передается в параметре pszRootPath, функция завершается ошибкой и возвращает код ошибки E_INVALIDARG. В более ранних версиях операционной системы можно передать пустую строку или NULL. Если pszRootPath содержит пустую строку или NULL, данные извлекаются для всех корзин на всех дисках.

Заметка

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

Требования

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

См. также

SHEmptyRecycleBin

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