Функция GetFileBandwidthReservation (winbase.h)

Статья
03/03/2024

Извлекает свойства резервирования пропускной способности тома, на котором находится указанный файл.

Синтаксис

BOOL GetFileBandwidthReservation(
  [in]  HANDLE  hFile,
  [out] LPDWORD lpPeriodMilliseconds,
  [out] LPDWORD lpBytesPerPeriod,
  [out] LPBOOL  pDiscardable,
  [out] LPDWORD lpTransferSize,
  [out] LPDWORD lpNumOutstandingRequests
);

Параметры

[in] hFile

Дескриптор файла.

[out] lpPeriodMilliseconds

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

[out] lpBytesPerPeriod

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

[out] pDiscardable

Значение TRUE , если операция ввода-вывода должна завершиться с ошибкой, если драйвер не может выполнить операцию ввода-вывода до истечения периода. False , если базовая подсистема не поддерживает сбой таким образом.

[out] lpTransferSize

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

[out] lpNumOutstandingRequests

Количество блоков TransferSize , которые могут быть невыполненными в операционной системе.

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

Возвращает ненулевое значение при успешном выполнении или нулевое значение в противном случае.

Дополнительные сведения об ошибке можно получить, вызвав GetLastError.

Технология	Поддерживается
Протокол SMB 3.0	Нет
SMB 3.0 Transparent Failover (TFO)	Нет
SMB 3.0 с масштабируемыми общими папками (SO)	Нет
Файловая система общего тома кластера (CSVFS)	Нет
Восстанавливаемая файловая система (ReFS)	Да

Требования

Требование	Значение
Минимальная версия клиента	Windows Vista [только классические приложения]
Минимальная версия сервера	Windows Server 2008 [только классические приложения]
Целевая платформа	Windows
Header	winbase.h (включая Windows.h)
Библиотека	Kernel32.lib
DLL	Kernel32.dll

См. также

Функции управления файлами

SetFileBandwidthReservation