ホーム › Storage.FileSystem › GetDiskFreeSpaceW

GetDiskFreeSpaceW

関数

ディスクのクラスタやセクタ情報と空き領域を取得する。

DLLKERNEL32.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

// KERNEL32.dll  (Unicode / -W)
#include <windows.h>

BOOL GetDiskFreeSpaceW(
    LPCWSTR lpRootPathName,   // optional
    DWORD* lpSectorsPerCluster,   // optional
    DWORD* lpBytesPerSector,   // optional
    DWORD* lpNumberOfFreeClusters,   // optional
    DWORD* lpTotalNumberOfClusters   // optional
);

パラメーター

名前	型	方向
lpRootPathName	LPCWSTR	inoptional
lpSectorsPerCluster	DWORD*	outoptional
lpBytesPerSector	DWORD*	outoptional
lpNumberOfFreeClusters	DWORD*	outoptional
lpTotalNumberOfClusters	DWORD*	outoptional

戻り値の型: BOOL

各言語での呼び出し定義

// KERNEL32.dll  (Unicode / -W)
#include <windows.h>

BOOL GetDiskFreeSpaceW(
    LPCWSTR lpRootPathName,   // optional
    DWORD* lpSectorsPerCluster,   // optional
    DWORD* lpBytesPerSector,   // optional
    DWORD* lpNumberOfFreeClusters,   // optional
    DWORD* lpTotalNumberOfClusters   // optional
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool GetDiskFreeSpaceW(
    [MarshalAs(UnmanagedType.LPWStr)] string lpRootPathName,   // LPCWSTR optional
    IntPtr lpSectorsPerCluster,   // DWORD* optional, out
    IntPtr lpBytesPerSector,   // DWORD* optional, out
    IntPtr lpNumberOfFreeClusters,   // DWORD* optional, out
    IntPtr lpTotalNumberOfClusters   // DWORD* optional, out
);

<DllImport("KERNEL32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetDiskFreeSpaceW(
    <MarshalAs(UnmanagedType.LPWStr)> lpRootPathName As String,   ' LPCWSTR optional
    lpSectorsPerCluster As IntPtr,   ' DWORD* optional, out
    lpBytesPerSector As IntPtr,   ' DWORD* optional, out
    lpNumberOfFreeClusters As IntPtr,   ' DWORD* optional, out
    lpTotalNumberOfClusters As IntPtr   ' DWORD* optional, out
) As Boolean
End Function

' lpRootPathName : LPCWSTR optional
' lpSectorsPerCluster : DWORD* optional, out
' lpBytesPerSector : DWORD* optional, out
' lpNumberOfFreeClusters : DWORD* optional, out
' lpTotalNumberOfClusters : DWORD* optional, out
Declare PtrSafe Function GetDiskFreeSpaceW Lib "kernel32" ( _
    ByVal lpRootPathName As LongPtr, _
    ByVal lpSectorsPerCluster As LongPtr, _
    ByVal lpBytesPerSector As LongPtr, _
    ByVal lpNumberOfFreeClusters As LongPtr, _
    ByVal lpTotalNumberOfClusters As LongPtr) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetDiskFreeSpaceW = ctypes.windll.kernel32.GetDiskFreeSpaceW
GetDiskFreeSpaceW.restype = wintypes.BOOL
GetDiskFreeSpaceW.argtypes = [
    wintypes.LPCWSTR,  # lpRootPathName : LPCWSTR optional
    ctypes.POINTER(wintypes.DWORD),  # lpSectorsPerCluster : DWORD* optional, out
    ctypes.POINTER(wintypes.DWORD),  # lpBytesPerSector : DWORD* optional, out
    ctypes.POINTER(wintypes.DWORD),  # lpNumberOfFreeClusters : DWORD* optional, out
    ctypes.POINTER(wintypes.DWORD),  # lpTotalNumberOfClusters : DWORD* optional, out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
GetDiskFreeSpaceW = Fiddle::Function.new(
  lib['GetDiskFreeSpaceW'],
  [
    Fiddle::TYPE_VOIDP,  # lpRootPathName : LPCWSTR optional
    Fiddle::TYPE_VOIDP,  # lpSectorsPerCluster : DWORD* optional, out
    Fiddle::TYPE_VOIDP,  # lpBytesPerSector : DWORD* optional, out
    Fiddle::TYPE_VOIDP,  # lpNumberOfFreeClusters : DWORD* optional, out
    Fiddle::TYPE_VOIDP,  # lpTotalNumberOfClusters : DWORD* optional, out
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "kernel32")]
extern "system" {
    fn GetDiskFreeSpaceW(
        lpRootPathName: *const u16,  // LPCWSTR optional
        lpSectorsPerCluster: *mut u32,  // DWORD* optional, out
        lpBytesPerSector: *mut u32,  // DWORD* optional, out
        lpNumberOfFreeClusters: *mut u32,  // DWORD* optional, out
        lpTotalNumberOfClusters: *mut u32  // DWORD* optional, out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Unicode, SetLastError = true)]
public static extern bool GetDiskFreeSpaceW([MarshalAs(UnmanagedType.LPWStr)] string lpRootPathName, IntPtr lpSectorsPerCluster, IntPtr lpBytesPerSector, IntPtr lpNumberOfFreeClusters, IntPtr lpTotalNumberOfClusters);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_GetDiskFreeSpaceW' -Namespace Win32 -PassThru
# $api::GetDiskFreeSpaceW(lpRootPathName, lpSectorsPerCluster, lpBytesPerSector, lpNumberOfFreeClusters, lpTotalNumberOfClusters)

#uselib "KERNEL32.dll"
#func global GetDiskFreeSpaceW "GetDiskFreeSpaceW" wptr, wptr, wptr, wptr, wptr
; GetDiskFreeSpaceW lpRootPathName, varptr(lpSectorsPerCluster), varptr(lpBytesPerSector), varptr(lpNumberOfFreeClusters), varptr(lpTotalNumberOfClusters)   ; 戻り値は stat
; lpRootPathName : LPCWSTR optional -> "wptr"
; lpSectorsPerCluster : DWORD* optional, out -> "wptr"
; lpBytesPerSector : DWORD* optional, out -> "wptr"
; lpNumberOfFreeClusters : DWORD* optional, out -> "wptr"
; lpTotalNumberOfClusters : DWORD* optional, out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "KERNEL32.dll"
#cfunc global GetDiskFreeSpaceW "GetDiskFreeSpaceW" wstr, var, var, var, var
; res = GetDiskFreeSpaceW(lpRootPathName, lpSectorsPerCluster, lpBytesPerSector, lpNumberOfFreeClusters, lpTotalNumberOfClusters)
; lpRootPathName : LPCWSTR optional -> "wstr"
; lpSectorsPerCluster : DWORD* optional, out -> "var"
; lpBytesPerSector : DWORD* optional, out -> "var"
; lpNumberOfFreeClusters : DWORD* optional, out -> "var"
; lpTotalNumberOfClusters : DWORD* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "KERNEL32.dll"
#cfunc global GetDiskFreeSpaceW "GetDiskFreeSpaceW" wstr, sptr, sptr, sptr, sptr
; res = GetDiskFreeSpaceW(lpRootPathName, varptr(lpSectorsPerCluster), varptr(lpBytesPerSector), varptr(lpNumberOfFreeClusters), varptr(lpTotalNumberOfClusters))
; lpRootPathName : LPCWSTR optional -> "wstr"
; lpSectorsPerCluster : DWORD* optional, out -> "sptr"
; lpBytesPerSector : DWORD* optional, out -> "sptr"
; lpNumberOfFreeClusters : DWORD* optional, out -> "sptr"
; lpTotalNumberOfClusters : DWORD* optional, out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。

出力引数:

; BOOL GetDiskFreeSpaceW(LPCWSTR lpRootPathName, DWORD* lpSectorsPerCluster, DWORD* lpBytesPerSector, DWORD* lpNumberOfFreeClusters, DWORD* lpTotalNumberOfClusters)
#uselib "KERNEL32.dll"
#cfunc global GetDiskFreeSpaceW "GetDiskFreeSpaceW" wstr, var, var, var, var
; res = GetDiskFreeSpaceW(lpRootPathName, lpSectorsPerCluster, lpBytesPerSector, lpNumberOfFreeClusters, lpTotalNumberOfClusters)
; lpRootPathName : LPCWSTR optional -> "wstr"
; lpSectorsPerCluster : DWORD* optional, out -> "var"
; lpBytesPerSector : DWORD* optional, out -> "var"
; lpNumberOfFreeClusters : DWORD* optional, out -> "var"
; lpTotalNumberOfClusters : DWORD* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; BOOL GetDiskFreeSpaceW(LPCWSTR lpRootPathName, DWORD* lpSectorsPerCluster, DWORD* lpBytesPerSector, DWORD* lpNumberOfFreeClusters, DWORD* lpTotalNumberOfClusters)
#uselib "KERNEL32.dll"
#cfunc global GetDiskFreeSpaceW "GetDiskFreeSpaceW" wstr, intptr, intptr, intptr, intptr
; res = GetDiskFreeSpaceW(lpRootPathName, varptr(lpSectorsPerCluster), varptr(lpBytesPerSector), varptr(lpNumberOfFreeClusters), varptr(lpTotalNumberOfClusters))
; lpRootPathName : LPCWSTR optional -> "wstr"
; lpSectorsPerCluster : DWORD* optional, out -> "intptr"
; lpBytesPerSector : DWORD* optional, out -> "intptr"
; lpNumberOfFreeClusters : DWORD* optional, out -> "intptr"
; lpTotalNumberOfClusters : DWORD* optional, out -> "intptr"
; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。

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

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procGetDiskFreeSpaceW = kernel32.NewProc("GetDiskFreeSpaceW")
)

// lpRootPathName (LPCWSTR optional), lpSectorsPerCluster (DWORD* optional, out), lpBytesPerSector (DWORD* optional, out), lpNumberOfFreeClusters (DWORD* optional, out), lpTotalNumberOfClusters (DWORD* optional, out)
r1, _, err := procGetDiskFreeSpaceW.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpRootPathName))),
	uintptr(lpSectorsPerCluster),
	uintptr(lpBytesPerSector),
	uintptr(lpNumberOfFreeClusters),
	uintptr(lpTotalNumberOfClusters),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL

function GetDiskFreeSpaceW(
  lpRootPathName: PWideChar;   // LPCWSTR optional
  lpSectorsPerCluster: Pointer;   // DWORD* optional, out
  lpBytesPerSector: Pointer;   // DWORD* optional, out
  lpNumberOfFreeClusters: Pointer;   // DWORD* optional, out
  lpTotalNumberOfClusters: Pointer   // DWORD* optional, out
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'GetDiskFreeSpaceW';

result := DllCall("KERNEL32\GetDiskFreeSpaceW"
    , "WStr", lpRootPathName   ; LPCWSTR optional
    , "Ptr", lpSectorsPerCluster   ; DWORD* optional, out
    , "Ptr", lpBytesPerSector   ; DWORD* optional, out
    , "Ptr", lpNumberOfFreeClusters   ; DWORD* optional, out
    , "Ptr", lpTotalNumberOfClusters   ; DWORD* optional, out
    , "Int")   ; return: BOOL

●GetDiskFreeSpaceW(lpRootPathName, lpSectorsPerCluster, lpBytesPerSector, lpNumberOfFreeClusters, lpTotalNumberOfClusters) = DLL("KERNEL32.dll", "bool GetDiskFreeSpaceW(char*, void*, void*, void*, void*)")
# 呼び出し: GetDiskFreeSpaceW(lpRootPathName, lpSectorsPerCluster, lpBytesPerSector, lpNumberOfFreeClusters, lpTotalNumberOfClusters)
# lpRootPathName : LPCWSTR optional -> "char*"
# lpSectorsPerCluster : DWORD* optional, out -> "void*"
# lpBytesPerSector : DWORD* optional, out -> "void*"
# lpNumberOfFreeClusters : DWORD* optional, out -> "void*"
# lpTotalNumberOfClusters : DWORD* optional, out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。