GetFileBandwidthReservation 関数 (winbase.h)

指定したファイルが存在するボリュームの帯域幅予約プロパティを取得します。

構文

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

パラメーター

[in] hFile

ファイルへのハンドル。

[out] lpPeriodMilliseconds

予約の期間を受け取る変数へのポインター (ミリ秒単位)。 期間は、I/O が完了するまでにカーネルに対して I/O が発行される時間です。 このハンドル用に帯域幅が予約されていない場合、返される値は、このボリュームでサポートされている最小予約期間です。

[out] lpBytesPerPeriod

ボリュームで予約できる期間あたりの最大バイト数を受け取る変数へのポインター。 このハンドル用に帯域幅が予約されていない場合、返される値は、ボリュームでサポートされている期間あたりの最大バイト数です。

[out] pDiscardable

ドライバー が期限切れになる前に I/O 操作を満たすことができない場合にエラーで I/O を完了する必要がある場合は TRUE。 基になるサブシステムでこの方法での失敗がサポートされていない場合は FALSE。

[out] lpTransferSize

アプリケーションによって発行される可能性がある個々の I/O 要求の最小サイズ。 すべての I/O 要求は 、TransferSize の倍数である必要があります。 このハンドル用に帯域幅が予約されていない場合、返される値は、このボリュームでサポートされている最小転送サイズです。

[out] lpNumOutstandingRequests

オペレーティング システムで未処理にできる TransferSize チャンクの数。

戻り値

成功した場合は 0 以外、それ以外の場合は 0 を返します。

詳細なエラー情報を得るには、GetLastError を呼び出します。

解説

Windows 8 と Windows Server 2012 では、この関数は、次のテクノロジによってサポートされています。

テクノロジ	サポートされています
サーバー メッセージ ブロック (SMB) 3.0 プロトコル	いいえ
SMB 3.0 Transparent Failover (TFO)	いいえ
スケールアウト ファイル共有 (SO) を使う SMB 3.0	いいえ
クラスターの共有ボリューム ファイル システム (CsvFS)	いいえ
Resilient File System (ReFS)	はい

必要条件

要件	値
サポートされている最小のクライアント	Windows Vista [デスクトップ アプリのみ]
サポートされている最小のサーバー	Windows Server 2008 [デスクトップ アプリのみ]
対象プラットフォーム	Windows
ヘッダー	winbase.h (Windows.h を含む)
Library	Kernel32.lib
[DLL]	Kernel32.dll

関連項目

File Management 関数

SetFileBandwidthReservation