ホーム › Storage.FileSystem › SetFileBandwidthReservation

SetFileBandwidthReservation

関数

ファイルハンドルにI/O帯域幅予約を設定する。

DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降

シグネチャ

// KERNEL32.dll
#include <windows.h>

BOOL SetFileBandwidthReservation(
    HANDLE hFile,
    DWORD nPeriodMilliseconds,
    DWORD nBytesPerPeriod,
    BOOL bDiscardable,
    DWORD* lpTransferSize,
    DWORD* lpNumOutstandingRequests
);

パラメーター

名前	型	方向	説明
hFile	HANDLE	in	ファイルへのハンドル。
nPeriodMilliseconds	DWORD	in	予約する期間(ミリ秒単位)。期間とは、I/O がカーネルに発行されてから、その I/O が完了すべき時点までの時間です。ファイルストリームでサポートされる最小値は、帯域幅予約を設定していないハンドルに対して GetFileBandwidthReservation 関数の lpPeriodMilliseconds パラメーターを通じて返される値を調べることで判定できます。
nBytesPerPeriod	DWORD	in	予約する帯域幅(期間あたりのバイト数)。ファイルストリームでサポートされる最大値は、帯域幅予約を設定していないハンドルに対して GetFileBandwidthReservation 関数の lpBytesPerPeriod パラメーターを通じて返される値を調べることで判定できます。
bDiscardable	BOOL	in	ドライバーが期間の満了前に I/O 操作を満たせない場合に、その I/O をエラーで完了すべきかどうかを示します。指定したファイルストリームのドライバーのいずれかがこの機能をサポートしていない場合、この関数は成功を返してフラグを無視することがあります。設定が反映されるかどうかを確認するには、同じ hFile ハンドルを使用して GetFileBandwidthReservation 関数を呼び出し、*pDiscardable の戻り値を調べてください。
lpTransferSize	DWORD*	out	アプリケーションが発行する可能性のある個々の I/O 要求の最小サイズを受け取る変数へのポインター。すべての I/O 要求は TransferSize の倍数である必要があります。
lpNumOutstandingRequests	DWORD*	out	アプリケーションがオペレーティングシステムに対して未完了のまま許容すべき TransferSize チャンクの数を受け取る変数へのポインター。これにより、ストレージスタックがデバイスをビジー状態に保ち、最大のスループットを実現できます。

戻り値の型: BOOL

公式ドキュメント

指定したファイルストリームに対して帯域幅を予約するよう要求します。予約は、指定したファイルハンドルに対する I/O 要求について、ミリ秒単位の期間内のバイト数として指定します。

戻り値

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

既存の予約が原因でボリュームに十分な帯域幅が利用できない場合、予約は失敗することがあります。この場合は ERROR_NO_SYSTEM_RESOURCES が返されます。

拡張エラー情報を取得するには、 GetLastError を呼び出してください。

解説(Remarks)

要求する帯域幅予約は、1 期間あたり 1 パケット以上である必要があります。特定のボリュームの最小期間(ミリ秒単位)、期間あたりの最大バイト数、および最小転送サイズ(バイト単位)は、 SetFileBandwidthReservation の呼び出しで使用されていないハンドルに対する GetFileBandwidthReservation の lpPeriodMilliseconds、lpBytesPerPeriod、および lpTransferSize パラメーターを通じて返されます。言い換えると、次のようになります。

1 ≤ (nBytesPerPeriod)×(lpPeriodMilliseconds)/(lpTransferSize)/(nPeriodMilliseconds)

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

テクノロジ	サポート
Server Message Block (SMB) 3.0 プロトコル	いいえ
SMB 3.0 Transparent Failover (TFO)	いいえ
SMB 3.0 with Scale-out File Shares (SO)	いいえ
Cluster Shared Volume File System (CsvFS)	いいえ
Resilient File System (ReFS)	はい

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// KERNEL32.dll
#include <windows.h>

BOOL SetFileBandwidthReservation(
    HANDLE hFile,
    DWORD nPeriodMilliseconds,
    DWORD nBytesPerPeriod,
    BOOL bDiscardable,
    DWORD* lpTransferSize,
    DWORD* lpNumOutstandingRequests
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool SetFileBandwidthReservation(
    IntPtr hFile,   // HANDLE
    uint nPeriodMilliseconds,   // DWORD
    uint nBytesPerPeriod,   // DWORD
    bool bDiscardable,   // BOOL
    out uint lpTransferSize,   // DWORD* out
    out uint lpNumOutstandingRequests   // DWORD* out
);

<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SetFileBandwidthReservation(
    hFile As IntPtr,   ' HANDLE
    nPeriodMilliseconds As UInteger,   ' DWORD
    nBytesPerPeriod As UInteger,   ' DWORD
    bDiscardable As Boolean,   ' BOOL
    <Out> ByRef lpTransferSize As UInteger,   ' DWORD* out
    <Out> ByRef lpNumOutstandingRequests As UInteger   ' DWORD* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hFile : HANDLE
' nPeriodMilliseconds : DWORD
' nBytesPerPeriod : DWORD
' bDiscardable : BOOL
' lpTransferSize : DWORD* out
' lpNumOutstandingRequests : DWORD* out
Declare PtrSafe Function SetFileBandwidthReservation Lib "kernel32" ( _
    ByVal hFile As LongPtr, _
    ByVal nPeriodMilliseconds As Long, _
    ByVal nBytesPerPeriod As Long, _
    ByVal bDiscardable As Long, _
    ByRef lpTransferSize As Long, _
    ByRef lpNumOutstandingRequests As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

SetFileBandwidthReservation = ctypes.windll.kernel32.SetFileBandwidthReservation
SetFileBandwidthReservation.restype = wintypes.BOOL
SetFileBandwidthReservation.argtypes = [
    wintypes.HANDLE,  # hFile : HANDLE
    wintypes.DWORD,  # nPeriodMilliseconds : DWORD
    wintypes.DWORD,  # nBytesPerPeriod : DWORD
    wintypes.BOOL,  # bDiscardable : BOOL
    ctypes.POINTER(wintypes.DWORD),  # lpTransferSize : DWORD* out
    ctypes.POINTER(wintypes.DWORD),  # lpNumOutstandingRequests : DWORD* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
SetFileBandwidthReservation = Fiddle::Function.new(
  lib['SetFileBandwidthReservation'],
  [
    Fiddle::TYPE_VOIDP,  # hFile : HANDLE
    -Fiddle::TYPE_INT,  # nPeriodMilliseconds : DWORD
    -Fiddle::TYPE_INT,  # nBytesPerPeriod : DWORD
    Fiddle::TYPE_INT,  # bDiscardable : BOOL
    Fiddle::TYPE_VOIDP,  # lpTransferSize : DWORD* out
    Fiddle::TYPE_VOIDP,  # lpNumOutstandingRequests : DWORD* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "kernel32")]
extern "system" {
    fn SetFileBandwidthReservation(
        hFile: *mut core::ffi::c_void,  // HANDLE
        nPeriodMilliseconds: u32,  // DWORD
        nBytesPerPeriod: u32,  // DWORD
        bDiscardable: i32,  // BOOL
        lpTransferSize: *mut u32,  // DWORD* out
        lpNumOutstandingRequests: *mut u32  // DWORD* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true)]
public static extern bool SetFileBandwidthReservation(IntPtr hFile, uint nPeriodMilliseconds, uint nBytesPerPeriod, bool bDiscardable, out uint lpTransferSize, out uint lpNumOutstandingRequests);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_SetFileBandwidthReservation' -Namespace Win32 -PassThru
# $api::SetFileBandwidthReservation(hFile, nPeriodMilliseconds, nBytesPerPeriod, bDiscardable, lpTransferSize, lpNumOutstandingRequests)

#uselib "KERNEL32.dll"
#func global SetFileBandwidthReservation "SetFileBandwidthReservation" sptr, sptr, sptr, sptr, sptr, sptr
; SetFileBandwidthReservation hFile, nPeriodMilliseconds, nBytesPerPeriod, bDiscardable, varptr(lpTransferSize), varptr(lpNumOutstandingRequests)   ; 戻り値は stat
; hFile : HANDLE -> "sptr"
; nPeriodMilliseconds : DWORD -> "sptr"
; nBytesPerPeriod : DWORD -> "sptr"
; bDiscardable : BOOL -> "sptr"
; lpTransferSize : DWORD* out -> "sptr"
; lpNumOutstandingRequests : DWORD* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "KERNEL32.dll"
#cfunc global SetFileBandwidthReservation "SetFileBandwidthReservation" sptr, int, int, int, var, var
; res = SetFileBandwidthReservation(hFile, nPeriodMilliseconds, nBytesPerPeriod, bDiscardable, lpTransferSize, lpNumOutstandingRequests)
; hFile : HANDLE -> "sptr"
; nPeriodMilliseconds : DWORD -> "int"
; nBytesPerPeriod : DWORD -> "int"
; bDiscardable : BOOL -> "int"
; lpTransferSize : DWORD* out -> "var"
; lpNumOutstandingRequests : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "KERNEL32.dll"
#cfunc global SetFileBandwidthReservation "SetFileBandwidthReservation" sptr, int, int, int, sptr, sptr
; res = SetFileBandwidthReservation(hFile, nPeriodMilliseconds, nBytesPerPeriod, bDiscardable, varptr(lpTransferSize), varptr(lpNumOutstandingRequests))
; hFile : HANDLE -> "sptr"
; nPeriodMilliseconds : DWORD -> "int"
; nBytesPerPeriod : DWORD -> "int"
; bDiscardable : BOOL -> "int"
; lpTransferSize : DWORD* out -> "sptr"
; lpNumOutstandingRequests : DWORD* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。