Функция GetDiskFreeSpaceA (fileapi.h)

Статья
02/29/2024

Извлекает сведения об указанном диске, включая объем свободного места на диске.

Синтаксис

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.

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

Требования

Требование	Значение
Минимальная версия клиента	Windows XP [классические приложения \| Приложения UWP]
Минимальная версия сервера	Windows Server 2003 [классические приложения \| Приложения UWP]
Целевая платформа	Windows
Header	fileapi.h (включая Windows.h)
Библиотека	Kernel32.lib
DLL	Kernel32.dll

См. также

Функции управления дисками

GetDiskFreeSpaceEx

GetDriveType