Функция SHGetDiskFreeSpaceExA (shellapi.h)
Извлекает сведения о пространстве диска для тома диска.
Синтаксис
BOOL SHGetDiskFreeSpaceExA(
[in] LPCSTR pszDirectoryName,
[out, optional] ULARGE_INTEGER *pulFreeBytesAvailableToCaller,
[out, optional] ULARGE_INTEGER *pulTotalNumberOfBytes,
[out, optional] ULARGE_INTEGER *pulTotalNumberOfFreeBytes
);
Параметры
[in] pszDirectoryName
Тип: LPCTSTR
Строка, завершающая значение NULL, указывающая том, для которого извлекаются сведения о размере. Это может быть буква диска, имя UNC или путь к папке. Для представления текущего диска нельзя использовать NULL.
[out, optional] pulFreeBytesAvailableToCaller
Тип: ULARGE_INTEGER*
Указатель на значение, которое получает количество байтов в томе, доступном вызывающем приложению. Если операционная система реализует квоты на пользователя, это значение может быть меньше общего количества свободных байтов на томе.
[out, optional] pulTotalNumberOfBytes
Тип: ULARGE_INTEGER*
Указатель на значение, которое получает общий размер тома в байтах.
[out, optional] pulTotalNumberOfFreeBytes
Тип: ULARGE_INTEGER*
Указатель на значение, которое получает количество байтов свободного места на томе.
Возвращаемое значение
Тип: BOOL
Возвращает TRUE, если выполнено успешно, FALSE в противном случае.
Замечания
Аналогично именованной функции SHGetDiskFreeSpace является просто псевдонимом SHGetDiskFreeSpaceEx. При вызове SHGetDiskFreeSpace вы фактически вызываете эту функцию.
Эта функция вызывает функцию GetDiskFreeSpaceEx, если она доступна в операционной системе. Если GetDiskFreeSpaceEx недоступно, он эмулируется путем вызова функции GetDiskFreeSpace и управления возвращаемыми значениями. Дополнительные сведения см. в документации по GetDiskFreeSpaceEx.
Заметка
Заголовок shellapi.h определяет SHGetDiskFreeSpaceEx в качестве псевдонима, который автоматически выбирает версию ANSI или Юникод этой функции на основе определения константы препроцессора ЮНИКОДа. Сочетание использования псевдонима, нейтрального для кодирования, с кодом, не зависящим от кодирования, может привести к несоответствиям, которые приводят к ошибкам компиляции или среды выполнения. Дополнительные сведения см. в соглашениях о прототипах функций.
Требования
| Требование | Ценность |
|---|---|
| минимальные поддерживаемые клиентские | Windows 2000 Профессиональный, Windows XP [только классические приложения] |
| минимальный поддерживаемый сервер | Windows Server 2003 [только классические приложения] |
| целевая платформа | Виндоус |
| заголовка | shellapi.h |
| библиотеки |
Shell32.lib |
| DLL | Shell32.dll (версия 5.0 или более поздняя версия) |