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

  • Статья

Извлекает сведения о свободном пространстве, доступном на томе диска, т. е. общий объем пространства, общий объем свободного места и общий объем свободного места, доступного пользователю, связанному с вызывающим потоком.

Синтаксис

BOOL GetDiskFreeSpaceExW(
  [in, optional]  LPCWSTR         lpDirectoryName,
  [out, optional] PULARGE_INTEGER lpFreeBytesAvailableToCaller,
  [out, optional] PULARGE_INTEGER lpTotalNumberOfBytes,
  [out, optional] PULARGE_INTEGER lpTotalNumberOfFreeBytes
);

Параметры

[in, optional] lpDirectoryName

Каталог на диске.

Если этот параметр имеет значение NULL, функция использует корень текущего диска.

Если этот параметр является UNC-именем, он должен содержать конечную обратную косую черту, например "\\MyServer\MyShare\".

Этот параметр не должен указывать корневой каталог на диске. Функция принимает любой каталог на диске.

Вызывающее приложение должно иметь FILE_LIST_DIRECTORY права доступа для этого
драйвера JDBC.

[out, optional] lpFreeBytesAvailableToCaller

Указатель на переменную, которая получает общее количество свободных байтов на диске, доступных пользователю, связанному с вызывающим потоком.

Этот параметр может принимать значение NULL.

Если используются квоты на пользователя, это значение может быть меньше общего числа свободных байтов на диске.

[out, optional] lpTotalNumberOfBytes

Указатель на переменную, которая получает общее количество байтов на диске, доступных пользователю, связанному с вызывающим потоком.

Этот параметр может принимать значение NULL.

Если используются квоты на пользователя, это значение может быть меньше общего числа байтов на диске.

Чтобы определить общее количество байтов на диске или томе, используйте IOCTL_DISK_GET_LENGTH_INFO.

[out, optional] lpTotalNumberOfFreeBytes

Указатель на переменную, получающую общее количество свободных байтов на диске.

Этот параметр может принимать значение NULL.

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

Если функция выполняется успешно, возвращается ненулевое значение.

Если функция завершается ошибкой, возвращаемое значение равно нулю (0). Дополнительные сведения об ошибке можно получить, вызвав GetLastError.

Комментарии

Значения, полученные этой функцией, относятся к типу ULARGE_INTEGER. Не усекайте эти значения до 32 бит.

Функция GetDiskFreeSpaceEx возвращает ноль (0) для lpTotalNumberOfFreeBytes и lpFreeBytesAvailable для всех запросов компакт-дисков, если диск не является незаписанным компакт-диском на диске CD-RW.

Поведение символьной ссылки. Если путь указывает на символьную ссылку, операция выполняется в целевом объекте.

Примечание

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

Требования

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

См. также

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

GetDiskFreeSpace

GetModuleHandle