ホーム › Storage.FileSystem › GetDiskFreeSpaceExA

GetDiskFreeSpaceExA

関数

ディスクの総容量と空き容量をバイト単位で取得する(ANSI版)。

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

シグネチャ

// KERNEL32.dll  (ANSI / -A)
#include <windows.h>

BOOL GetDiskFreeSpaceExA(
    LPCSTR lpDirectoryName,   // optional
    ULONGLONG* lpFreeBytesAvailableToCaller,   // optional
    ULONGLONG* lpTotalNumberOfBytes,   // optional
    ULONGLONG* lpTotalNumberOfFreeBytes   // optional
);

パラメーター

名前	型	方向
lpDirectoryName	LPCSTR	inoptional
lpFreeBytesAvailableToCaller	ULONGLONG*	outoptional
lpTotalNumberOfBytes	ULONGLONG*	outoptional
lpTotalNumberOfFreeBytes	ULONGLONG*	outoptional

戻り値の型: BOOL

各言語での呼び出し定義

// KERNEL32.dll  (ANSI / -A)
#include <windows.h>

BOOL GetDiskFreeSpaceExA(
    LPCSTR lpDirectoryName,   // optional
    ULONGLONG* lpFreeBytesAvailableToCaller,   // optional
    ULONGLONG* lpTotalNumberOfBytes,   // optional
    ULONGLONG* lpTotalNumberOfFreeBytes   // optional
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool GetDiskFreeSpaceExA(
    [MarshalAs(UnmanagedType.LPStr)] string lpDirectoryName,   // LPCSTR optional
    IntPtr lpFreeBytesAvailableToCaller,   // ULONGLONG* optional, out
    IntPtr lpTotalNumberOfBytes,   // ULONGLONG* optional, out
    IntPtr lpTotalNumberOfFreeBytes   // ULONGLONG* optional, out
);

<DllImport("KERNEL32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetDiskFreeSpaceExA(
    <MarshalAs(UnmanagedType.LPStr)> lpDirectoryName As String,   ' LPCSTR optional
    lpFreeBytesAvailableToCaller As IntPtr,   ' ULONGLONG* optional, out
    lpTotalNumberOfBytes As IntPtr,   ' ULONGLONG* optional, out
    lpTotalNumberOfFreeBytes As IntPtr   ' ULONGLONG* optional, out
) As Boolean
End Function

' lpDirectoryName : LPCSTR optional
' lpFreeBytesAvailableToCaller : ULONGLONG* optional, out
' lpTotalNumberOfBytes : ULONGLONG* optional, out
' lpTotalNumberOfFreeBytes : ULONGLONG* optional, out
Declare PtrSafe Function GetDiskFreeSpaceExA Lib "kernel32" ( _
    ByVal lpDirectoryName As String, _
    ByVal lpFreeBytesAvailableToCaller As LongPtr, _
    ByVal lpTotalNumberOfBytes As LongPtr, _
    ByVal lpTotalNumberOfFreeBytes As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetDiskFreeSpaceExA = ctypes.windll.kernel32.GetDiskFreeSpaceExA
GetDiskFreeSpaceExA.restype = wintypes.BOOL
GetDiskFreeSpaceExA.argtypes = [
    wintypes.LPCSTR,  # lpDirectoryName : LPCSTR optional
    ctypes.POINTER(ctypes.c_ulonglong),  # lpFreeBytesAvailableToCaller : ULONGLONG* optional, out
    ctypes.POINTER(ctypes.c_ulonglong),  # lpTotalNumberOfBytes : ULONGLONG* optional, out
    ctypes.POINTER(ctypes.c_ulonglong),  # lpTotalNumberOfFreeBytes : ULONGLONG* optional, out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
GetDiskFreeSpaceExA = Fiddle::Function.new(
  lib['GetDiskFreeSpaceExA'],
  [
    Fiddle::TYPE_VOIDP,  # lpDirectoryName : LPCSTR optional
    Fiddle::TYPE_VOIDP,  # lpFreeBytesAvailableToCaller : ULONGLONG* optional, out
    Fiddle::TYPE_VOIDP,  # lpTotalNumberOfBytes : ULONGLONG* optional, out
    Fiddle::TYPE_VOIDP,  # lpTotalNumberOfFreeBytes : ULONGLONG* optional, out
  ],
  Fiddle::TYPE_INT)

#[link(name = "kernel32")]
extern "system" {
    fn GetDiskFreeSpaceExA(
        lpDirectoryName: *const u8,  // LPCSTR optional
        lpFreeBytesAvailableToCaller: *mut u64,  // ULONGLONG* optional, out
        lpTotalNumberOfBytes: *mut u64,  // ULONGLONG* optional, out
        lpTotalNumberOfFreeBytes: *mut u64  // ULONGLONG* optional, out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, SetLastError = true)]
public static extern bool GetDiskFreeSpaceExA([MarshalAs(UnmanagedType.LPStr)] string lpDirectoryName, IntPtr lpFreeBytesAvailableToCaller, IntPtr lpTotalNumberOfBytes, IntPtr lpTotalNumberOfFreeBytes);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_GetDiskFreeSpaceExA' -Namespace Win32 -PassThru
# $api::GetDiskFreeSpaceExA(lpDirectoryName, lpFreeBytesAvailableToCaller, lpTotalNumberOfBytes, lpTotalNumberOfFreeBytes)

#uselib "KERNEL32.dll"
#func global GetDiskFreeSpaceExA "GetDiskFreeSpaceExA" sptr, sptr, sptr, sptr
; GetDiskFreeSpaceExA lpDirectoryName, varptr(lpFreeBytesAvailableToCaller), varptr(lpTotalNumberOfBytes), varptr(lpTotalNumberOfFreeBytes)   ; 戻り値は stat
; lpDirectoryName : LPCSTR optional -> "sptr"
; lpFreeBytesAvailableToCaller : ULONGLONG* optional, out -> "sptr"
; lpTotalNumberOfBytes : ULONGLONG* optional, out -> "sptr"
; lpTotalNumberOfFreeBytes : ULONGLONG* optional, out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "KERNEL32.dll"
#cfunc global GetDiskFreeSpaceExA "GetDiskFreeSpaceExA" str, var, var, var
; res = GetDiskFreeSpaceExA(lpDirectoryName, lpFreeBytesAvailableToCaller, lpTotalNumberOfBytes, lpTotalNumberOfFreeBytes)
; lpDirectoryName : LPCSTR optional -> "str"
; lpFreeBytesAvailableToCaller : ULONGLONG* optional, out -> "var"
; lpTotalNumberOfBytes : ULONGLONG* optional, out -> "var"
; lpTotalNumberOfFreeBytes : ULONGLONG* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "KERNEL32.dll"
#cfunc global GetDiskFreeSpaceExA "GetDiskFreeSpaceExA" str, sptr, sptr, sptr
; res = GetDiskFreeSpaceExA(lpDirectoryName, varptr(lpFreeBytesAvailableToCaller), varptr(lpTotalNumberOfBytes), varptr(lpTotalNumberOfFreeBytes))
; lpDirectoryName : LPCSTR optional -> "str"
; lpFreeBytesAvailableToCaller : ULONGLONG* optional, out -> "sptr"
; lpTotalNumberOfBytes : ULONGLONG* optional, out -> "sptr"
; lpTotalNumberOfFreeBytes : ULONGLONG* optional, out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。

出力引数:

; BOOL GetDiskFreeSpaceExA(LPCSTR lpDirectoryName, ULONGLONG* lpFreeBytesAvailableToCaller, ULONGLONG* lpTotalNumberOfBytes, ULONGLONG* lpTotalNumberOfFreeBytes)
#uselib "KERNEL32.dll"
#cfunc global GetDiskFreeSpaceExA "GetDiskFreeSpaceExA" str, var, var, var
; res = GetDiskFreeSpaceExA(lpDirectoryName, lpFreeBytesAvailableToCaller, lpTotalNumberOfBytes, lpTotalNumberOfFreeBytes)
; lpDirectoryName : LPCSTR optional -> "str"
; lpFreeBytesAvailableToCaller : ULONGLONG* optional, out -> "var"
; lpTotalNumberOfBytes : ULONGLONG* optional, out -> "var"
; lpTotalNumberOfFreeBytes : ULONGLONG* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; BOOL GetDiskFreeSpaceExA(LPCSTR lpDirectoryName, ULONGLONG* lpFreeBytesAvailableToCaller, ULONGLONG* lpTotalNumberOfBytes, ULONGLONG* lpTotalNumberOfFreeBytes)
#uselib "KERNEL32.dll"
#cfunc global GetDiskFreeSpaceExA "GetDiskFreeSpaceExA" str, intptr, intptr, intptr
; res = GetDiskFreeSpaceExA(lpDirectoryName, varptr(lpFreeBytesAvailableToCaller), varptr(lpTotalNumberOfBytes), varptr(lpTotalNumberOfFreeBytes))
; lpDirectoryName : LPCSTR optional -> "str"
; lpFreeBytesAvailableToCaller : ULONGLONG* optional, out -> "intptr"
; lpTotalNumberOfBytes : ULONGLONG* optional, out -> "intptr"
; lpTotalNumberOfFreeBytes : ULONGLONG* optional, out -> "intptr"
; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。

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

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procGetDiskFreeSpaceExA = kernel32.NewProc("GetDiskFreeSpaceExA")
)

// lpDirectoryName (LPCSTR optional), lpFreeBytesAvailableToCaller (ULONGLONG* optional, out), lpTotalNumberOfBytes (ULONGLONG* optional, out), lpTotalNumberOfFreeBytes (ULONGLONG* optional, out)
r1, _, err := procGetDiskFreeSpaceExA.Call(
	uintptr(unsafe.Pointer(windows.BytePtrFromString(lpDirectoryName))),
	uintptr(lpFreeBytesAvailableToCaller),
	uintptr(lpTotalNumberOfBytes),
	uintptr(lpTotalNumberOfFreeBytes),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL

function GetDiskFreeSpaceExA(
  lpDirectoryName: PAnsiChar;   // LPCSTR optional
  lpFreeBytesAvailableToCaller: Pointer;   // ULONGLONG* optional, out
  lpTotalNumberOfBytes: Pointer;   // ULONGLONG* optional, out
  lpTotalNumberOfFreeBytes: Pointer   // ULONGLONG* optional, out
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'GetDiskFreeSpaceExA';

result := DllCall("KERNEL32\GetDiskFreeSpaceExA"
    , "AStr", lpDirectoryName   ; LPCSTR optional
    , "Ptr", lpFreeBytesAvailableToCaller   ; ULONGLONG* optional, out
    , "Ptr", lpTotalNumberOfBytes   ; ULONGLONG* optional, out
    , "Ptr", lpTotalNumberOfFreeBytes   ; ULONGLONG* optional, out
    , "Int")   ; return: BOOL

●GetDiskFreeSpaceExA(lpDirectoryName, lpFreeBytesAvailableToCaller, lpTotalNumberOfBytes, lpTotalNumberOfFreeBytes) = DLL("KERNEL32.dll", "bool GetDiskFreeSpaceExA(char*, void*, void*, void*)")
# 呼び出し: GetDiskFreeSpaceExA(lpDirectoryName, lpFreeBytesAvailableToCaller, lpTotalNumberOfBytes, lpTotalNumberOfFreeBytes)
# lpDirectoryName : LPCSTR optional -> "char*"
# lpFreeBytesAvailableToCaller : ULONGLONG* optional, out -> "void*"
# lpTotalNumberOfBytes : ULONGLONG* optional, out -> "void*"
# lpTotalNumberOfFreeBytes : ULONGLONG* optional, out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。