Функция GetDiskFreeSpaceA (fileapi.h)
Извлекает сведения об указанном диске, включая объем свободного места на диске.
Синтаксис
BOOL GetDiskFreeSpaceA(
[in] LPCSTR lpRootPathName,
[out] LPDWORD lpSectorsPerCluster,
[out] LPDWORD lpBytesPerSector,
[out] LPDWORD lpNumberOfFreeClusters,
[out] LPDWORD lpTotalNumberOfClusters
);
Параметры
[in] lpRootPathName
Корневой каталог диска, для которого должны быть возвращены сведения. Если этот параметр null, функция использует корень текущего диска. Если этот параметр является именем UNC, он должен включать конечную обратную косую черту (например, \\MyServer\MyShare\). Кроме того, спецификация диска должна иметь конечную обратную косую черту (например, "C:\"). Вызывающее приложение должно иметь FILE_LIST_DIRECTORY права доступа к этому каталогу.
[out] lpSectorsPerCluster
Указатель на переменную, которая получает количество секторов на кластер.
[out] lpBytesPerSector
Указатель на переменную, которая получает количество байтов на сектор.
[out] lpNumberOfFreeClusters
Указатель на переменную, которая получает общее количество свободных кластеров на диске, доступном пользователю, связанному с вызывающим потоком.
Если квоты на диск используются для каждого пользователя, это значение может быть меньше общего количества свободных кластеров на диске.
[out] lpTotalNumberOfClusters
Указатель на переменную, которая получает общее количество кластеров на диске, доступное пользователю, связанному с вызывающим потоком.
Если квоты на диск используются для каждого пользователя, это значение может быть меньше общего количества кластеров на диске.
Возвращаемое значение
Если функция выполнена успешно, возвращаемое значение ненулевое.
Если функция завершается ошибкой, возвращаемое значение равно нулю. Чтобы получить расширенные сведения об ошибке, вызовите GetLastError.
Замечания
Функция GetDiskFreeSpaceEx позволяет избежать арифметики, необходимой для функции GetDiskFreeSpace.
Поведение символьной связи— если путь указывает на символьную ссылку, операция выполняется в целевом объекте.
Заметка
Заголовок fileapi.h определяет GetDiskFreeSpace как псевдоним, который автоматически выбирает версию ANSI или Юникод этой функции на основе определения константы препроцессора ЮНИКОДа. Сочетание использования псевдонима, нейтрального для кодирования, с кодом, не зависящим от кодирования, может привести к несоответствиям, которые приводят к ошибкам компиляции или среды выполнения. Дополнительные сведения см. в соглашениях о прототипах функций.
Требования
| Требование | Ценность |
|---|---|
| минимальные поддерживаемые клиентские | Windows XP [классические приложения | Приложения UWP] |
| минимальный поддерживаемый сервер | Windows Server 2003 [классические приложения | Приложения UWP] |
| целевая платформа | Виндоус |
| заголовка | fileapi.h (включая Windows.h) |
| библиотеки |
Kernel32.lib |
| DLL | Kernel32.dll |