Win32 API 日本語リファレンス
ホーム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
);

パラメーター

名前方向
hFileHANDLEin
nPeriodMillisecondsDWORDin
nBytesPerPeriodDWORDin
bDiscardableBOOLin
lpTransferSizeDWORD*out
lpNumOutstandingRequestsDWORD*out

戻り値の型: BOOL

各言語での呼び出し定義

// 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 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 方式にも切替可。
出力引数:
; BOOL SetFileBandwidthReservation(HANDLE hFile, DWORD nPeriodMilliseconds, DWORD nBytesPerPeriod, BOOL bDiscardable, DWORD* lpTransferSize, DWORD* lpNumOutstandingRequests)
#uselib "KERNEL32.dll"
#cfunc global SetFileBandwidthReservation "SetFileBandwidthReservation" intptr, int, int, int, var, var
; res = SetFileBandwidthReservation(hFile, nPeriodMilliseconds, nBytesPerPeriod, bDiscardable, lpTransferSize, lpNumOutstandingRequests)
; hFile : HANDLE -> "intptr"
; nPeriodMilliseconds : DWORD -> "int"
; nBytesPerPeriod : DWORD -> "int"
; bDiscardable : BOOL -> "int"
; lpTransferSize : DWORD* out -> "var"
; lpNumOutstandingRequests : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procSetFileBandwidthReservation = kernel32.NewProc("SetFileBandwidthReservation")
)

// hFile (HANDLE), nPeriodMilliseconds (DWORD), nBytesPerPeriod (DWORD), bDiscardable (BOOL), lpTransferSize (DWORD* out), lpNumOutstandingRequests (DWORD* out)
r1, _, err := procSetFileBandwidthReservation.Call(
	uintptr(hFile),
	uintptr(nPeriodMilliseconds),
	uintptr(nBytesPerPeriod),
	uintptr(bDiscardable),
	uintptr(lpTransferSize),
	uintptr(lpNumOutstandingRequests),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function SetFileBandwidthReservation(
  hFile: THandle;   // HANDLE
  nPeriodMilliseconds: DWORD;   // DWORD
  nBytesPerPeriod: DWORD;   // DWORD
  bDiscardable: BOOL;   // BOOL
  lpTransferSize: Pointer;   // DWORD* out
  lpNumOutstandingRequests: Pointer   // DWORD* out
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'SetFileBandwidthReservation';
result := DllCall("KERNEL32\SetFileBandwidthReservation"
    , "Ptr", hFile   ; HANDLE
    , "UInt", nPeriodMilliseconds   ; DWORD
    , "UInt", nBytesPerPeriod   ; DWORD
    , "Int", bDiscardable   ; BOOL
    , "Ptr", lpTransferSize   ; DWORD* out
    , "Ptr", lpNumOutstandingRequests   ; DWORD* out
    , "Int")   ; return: BOOL
●SetFileBandwidthReservation(hFile, nPeriodMilliseconds, nBytesPerPeriod, bDiscardable, lpTransferSize, lpNumOutstandingRequests) = DLL("KERNEL32.dll", "bool SetFileBandwidthReservation(void*, dword, dword, bool, void*, void*)")
# 呼び出し: SetFileBandwidthReservation(hFile, nPeriodMilliseconds, nBytesPerPeriod, bDiscardable, lpTransferSize, lpNumOutstandingRequests)
# hFile : HANDLE -> "void*"
# nPeriodMilliseconds : DWORD -> "dword"
# nBytesPerPeriod : DWORD -> "dword"
# bDiscardable : BOOL -> "bool"
# lpTransferSize : DWORD* out -> "void*"
# lpNumOutstandingRequests : DWORD* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。