ホーム › Storage.FileSystem › GetFileBandwidthReservation

GetFileBandwidthReservation

関数

ファイルハンドルのI/O帯域幅予約情報を取得する。

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

シグネチャ

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

BOOL GetFileBandwidthReservation(
    HANDLE hFile,
    DWORD* lpPeriodMilliseconds,
    DWORD* lpBytesPerPeriod,
    BOOL* pDiscardable,
    DWORD* lpTransferSize,
    DWORD* lpNumOutstandingRequests
);

パラメーター

名前	型	方向
hFile	HANDLE	in
lpPeriodMilliseconds	DWORD*	out
lpBytesPerPeriod	DWORD*	out
pDiscardable	BOOL*	out
lpTransferSize	DWORD*	out
lpNumOutstandingRequests	DWORD*	out

戻り値の型: BOOL

各言語での呼び出し定義

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

BOOL GetFileBandwidthReservation(
    HANDLE hFile,
    DWORD* lpPeriodMilliseconds,
    DWORD* lpBytesPerPeriod,
    BOOL* pDiscardable,
    DWORD* lpTransferSize,
    DWORD* lpNumOutstandingRequests
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool GetFileBandwidthReservation(
    IntPtr hFile,   // HANDLE
    out uint lpPeriodMilliseconds,   // DWORD* out
    out uint lpBytesPerPeriod,   // DWORD* out
    out int pDiscardable,   // BOOL* out
    out uint lpTransferSize,   // DWORD* out
    out uint lpNumOutstandingRequests   // DWORD* out
);

<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetFileBandwidthReservation(
    hFile As IntPtr,   ' HANDLE
    <Out> ByRef lpPeriodMilliseconds As UInteger,   ' DWORD* out
    <Out> ByRef lpBytesPerPeriod As UInteger,   ' DWORD* out
    <Out> ByRef pDiscardable As Integer,   ' BOOL* out
    <Out> ByRef lpTransferSize As UInteger,   ' DWORD* out
    <Out> ByRef lpNumOutstandingRequests As UInteger   ' DWORD* out
) As Boolean
End Function

' hFile : HANDLE
' lpPeriodMilliseconds : DWORD* out
' lpBytesPerPeriod : DWORD* out
' pDiscardable : BOOL* out
' lpTransferSize : DWORD* out
' lpNumOutstandingRequests : DWORD* out
Declare PtrSafe Function GetFileBandwidthReservation Lib "kernel32" ( _
    ByVal hFile As LongPtr, _
    ByRef lpPeriodMilliseconds As Long, _
    ByRef lpBytesPerPeriod As Long, _
    ByRef pDiscardable 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

GetFileBandwidthReservation = ctypes.windll.kernel32.GetFileBandwidthReservation
GetFileBandwidthReservation.restype = wintypes.BOOL
GetFileBandwidthReservation.argtypes = [
    wintypes.HANDLE,  # hFile : HANDLE
    ctypes.POINTER(wintypes.DWORD),  # lpPeriodMilliseconds : DWORD* out
    ctypes.POINTER(wintypes.DWORD),  # lpBytesPerPeriod : DWORD* out
    ctypes.c_void_p,  # pDiscardable : BOOL* out
    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')
GetFileBandwidthReservation = Fiddle::Function.new(
  lib['GetFileBandwidthReservation'],
  [
    Fiddle::TYPE_VOIDP,  # hFile : HANDLE
    Fiddle::TYPE_VOIDP,  # lpPeriodMilliseconds : DWORD* out
    Fiddle::TYPE_VOIDP,  # lpBytesPerPeriod : DWORD* out
    Fiddle::TYPE_VOIDP,  # pDiscardable : BOOL* out
    Fiddle::TYPE_VOIDP,  # lpTransferSize : DWORD* out
    Fiddle::TYPE_VOIDP,  # lpNumOutstandingRequests : DWORD* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "kernel32")]
extern "system" {
    fn GetFileBandwidthReservation(
        hFile: *mut core::ffi::c_void,  // HANDLE
        lpPeriodMilliseconds: *mut u32,  // DWORD* out
        lpBytesPerPeriod: *mut u32,  // DWORD* out
        pDiscardable: *mut i32,  // BOOL* out
        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 GetFileBandwidthReservation(IntPtr hFile, out uint lpPeriodMilliseconds, out uint lpBytesPerPeriod, out int pDiscardable, out uint lpTransferSize, out uint lpNumOutstandingRequests);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_GetFileBandwidthReservation' -Namespace Win32 -PassThru
# $api::GetFileBandwidthReservation(hFile, lpPeriodMilliseconds, lpBytesPerPeriod, pDiscardable, lpTransferSize, lpNumOutstandingRequests)

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

出力引数:

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

出力引数:

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

import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procGetFileBandwidthReservation = kernel32.NewProc("GetFileBandwidthReservation")
)

// hFile (HANDLE), lpPeriodMilliseconds (DWORD* out), lpBytesPerPeriod (DWORD* out), pDiscardable (BOOL* out), lpTransferSize (DWORD* out), lpNumOutstandingRequests (DWORD* out)
r1, _, err := procGetFileBandwidthReservation.Call(
	uintptr(hFile),
	uintptr(lpPeriodMilliseconds),
	uintptr(lpBytesPerPeriod),
	uintptr(pDiscardable),
	uintptr(lpTransferSize),
	uintptr(lpNumOutstandingRequests),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL

function GetFileBandwidthReservation(
  hFile: THandle;   // HANDLE
  lpPeriodMilliseconds: Pointer;   // DWORD* out
  lpBytesPerPeriod: Pointer;   // DWORD* out
  pDiscardable: Pointer;   // BOOL* out
  lpTransferSize: Pointer;   // DWORD* out
  lpNumOutstandingRequests: Pointer   // DWORD* out
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'GetFileBandwidthReservation';

result := DllCall("KERNEL32\GetFileBandwidthReservation"
    , "Ptr", hFile   ; HANDLE
    , "Ptr", lpPeriodMilliseconds   ; DWORD* out
    , "Ptr", lpBytesPerPeriod   ; DWORD* out
    , "Ptr", pDiscardable   ; BOOL* out
    , "Ptr", lpTransferSize   ; DWORD* out
    , "Ptr", lpNumOutstandingRequests   ; DWORD* out
    , "Int")   ; return: BOOL

●GetFileBandwidthReservation(hFile, lpPeriodMilliseconds, lpBytesPerPeriod, pDiscardable, lpTransferSize, lpNumOutstandingRequests) = DLL("KERNEL32.dll", "bool GetFileBandwidthReservation(void*, void*, void*, void*, void*, void*)")
# 呼び出し: GetFileBandwidthReservation(hFile, lpPeriodMilliseconds, lpBytesPerPeriod, pDiscardable, lpTransferSize, lpNumOutstandingRequests)
# hFile : HANDLE -> "void*"
# lpPeriodMilliseconds : DWORD* out -> "void*"
# lpBytesPerPeriod : DWORD* out -> "void*"
# pDiscardable : BOOL* out -> "void*"
# lpTransferSize : DWORD* out -> "void*"
# lpNumOutstandingRequests : DWORD* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。