ホーム › UI.Shell › SHGetDiskFreeSpaceExA

SHGetDiskFreeSpaceExA

関数

指定ディレクトリのディスク空き容量と総容量を取得する。

DLLSHELL32.dll文字セットANSI (-A)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

BOOL SHGetDiskFreeSpaceExA(
    LPCSTR pszDirectoryName,
    ULONGLONG* pulFreeBytesAvailableToCaller,   // optional
    ULONGLONG* pulTotalNumberOfBytes,   // optional
    ULONGLONG* pulTotalNumberOfFreeBytes   // optional
);

パラメーター

名前	型	方向
pszDirectoryName	LPCSTR	in
pulFreeBytesAvailableToCaller	ULONGLONG*	outoptional
pulTotalNumberOfBytes	ULONGLONG*	outoptional
pulTotalNumberOfFreeBytes	ULONGLONG*	outoptional

戻り値の型: BOOL

各言語での呼び出し定義

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

BOOL SHGetDiskFreeSpaceExA(
    LPCSTR pszDirectoryName,
    ULONGLONG* pulFreeBytesAvailableToCaller,   // optional
    ULONGLONG* pulTotalNumberOfBytes,   // optional
    ULONGLONG* pulTotalNumberOfFreeBytes   // optional
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SHELL32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern bool SHGetDiskFreeSpaceExA(
    [MarshalAs(UnmanagedType.LPStr)] string pszDirectoryName,   // LPCSTR
    IntPtr pulFreeBytesAvailableToCaller,   // ULONGLONG* optional, out
    IntPtr pulTotalNumberOfBytes,   // ULONGLONG* optional, out
    IntPtr pulTotalNumberOfFreeBytes   // ULONGLONG* optional, out
);

<DllImport("SHELL32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function SHGetDiskFreeSpaceExA(
    <MarshalAs(UnmanagedType.LPStr)> pszDirectoryName As String,   ' LPCSTR
    pulFreeBytesAvailableToCaller As IntPtr,   ' ULONGLONG* optional, out
    pulTotalNumberOfBytes As IntPtr,   ' ULONGLONG* optional, out
    pulTotalNumberOfFreeBytes As IntPtr   ' ULONGLONG* optional, out
) As Boolean
End Function

' pszDirectoryName : LPCSTR
' pulFreeBytesAvailableToCaller : ULONGLONG* optional, out
' pulTotalNumberOfBytes : ULONGLONG* optional, out
' pulTotalNumberOfFreeBytes : ULONGLONG* optional, out
Declare PtrSafe Function SHGetDiskFreeSpaceExA Lib "shell32" ( _
    ByVal pszDirectoryName As String, _
    ByVal pulFreeBytesAvailableToCaller As LongPtr, _
    ByVal pulTotalNumberOfBytes As LongPtr, _
    ByVal pulTotalNumberOfFreeBytes As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

SHGetDiskFreeSpaceExA = ctypes.windll.shell32.SHGetDiskFreeSpaceExA
SHGetDiskFreeSpaceExA.restype = wintypes.BOOL
SHGetDiskFreeSpaceExA.argtypes = [
    wintypes.LPCSTR,  # pszDirectoryName : LPCSTR
    ctypes.POINTER(ctypes.c_ulonglong),  # pulFreeBytesAvailableToCaller : ULONGLONG* optional, out
    ctypes.POINTER(ctypes.c_ulonglong),  # pulTotalNumberOfBytes : ULONGLONG* optional, out
    ctypes.POINTER(ctypes.c_ulonglong),  # pulTotalNumberOfFreeBytes : ULONGLONG* optional, out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHELL32.dll')
SHGetDiskFreeSpaceExA = Fiddle::Function.new(
  lib['SHGetDiskFreeSpaceExA'],
  [
    Fiddle::TYPE_VOIDP,  # pszDirectoryName : LPCSTR
    Fiddle::TYPE_VOIDP,  # pulFreeBytesAvailableToCaller : ULONGLONG* optional, out
    Fiddle::TYPE_VOIDP,  # pulTotalNumberOfBytes : ULONGLONG* optional, out
    Fiddle::TYPE_VOIDP,  # pulTotalNumberOfFreeBytes : ULONGLONG* optional, out
  ],
  Fiddle::TYPE_INT)

#[link(name = "shell32")]
extern "system" {
    fn SHGetDiskFreeSpaceExA(
        pszDirectoryName: *const u8,  // LPCSTR
        pulFreeBytesAvailableToCaller: *mut u64,  // ULONGLONG* optional, out
        pulTotalNumberOfBytes: *mut u64,  // ULONGLONG* optional, out
        pulTotalNumberOfFreeBytes: *mut u64  // ULONGLONG* optional, out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SHELL32.dll", CharSet = CharSet.Ansi)]
public static extern bool SHGetDiskFreeSpaceExA([MarshalAs(UnmanagedType.LPStr)] string pszDirectoryName, IntPtr pulFreeBytesAvailableToCaller, IntPtr pulTotalNumberOfBytes, IntPtr pulTotalNumberOfFreeBytes);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHELL32_SHGetDiskFreeSpaceExA' -Namespace Win32 -PassThru
# $api::SHGetDiskFreeSpaceExA(pszDirectoryName, pulFreeBytesAvailableToCaller, pulTotalNumberOfBytes, pulTotalNumberOfFreeBytes)

#uselib "SHELL32.dll"
#func global SHGetDiskFreeSpaceExA "SHGetDiskFreeSpaceExA" sptr, sptr, sptr, sptr
; SHGetDiskFreeSpaceExA pszDirectoryName, varptr(pulFreeBytesAvailableToCaller), varptr(pulTotalNumberOfBytes), varptr(pulTotalNumberOfFreeBytes)   ; 戻り値は stat
; pszDirectoryName : LPCSTR -> "sptr"
; pulFreeBytesAvailableToCaller : ULONGLONG* optional, out -> "sptr"
; pulTotalNumberOfBytes : ULONGLONG* optional, out -> "sptr"
; pulTotalNumberOfFreeBytes : ULONGLONG* optional, out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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

出力引数:

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

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

var (
	shell32 = windows.NewLazySystemDLL("SHELL32.dll")
	procSHGetDiskFreeSpaceExA = shell32.NewProc("SHGetDiskFreeSpaceExA")
)

// pszDirectoryName (LPCSTR), pulFreeBytesAvailableToCaller (ULONGLONG* optional, out), pulTotalNumberOfBytes (ULONGLONG* optional, out), pulTotalNumberOfFreeBytes (ULONGLONG* optional, out)
r1, _, err := procSHGetDiskFreeSpaceExA.Call(
	uintptr(unsafe.Pointer(windows.BytePtrFromString(pszDirectoryName))),
	uintptr(pulFreeBytesAvailableToCaller),
	uintptr(pulTotalNumberOfBytes),
	uintptr(pulTotalNumberOfFreeBytes),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL

function SHGetDiskFreeSpaceExA(
  pszDirectoryName: PAnsiChar;   // LPCSTR
  pulFreeBytesAvailableToCaller: Pointer;   // ULONGLONG* optional, out
  pulTotalNumberOfBytes: Pointer;   // ULONGLONG* optional, out
  pulTotalNumberOfFreeBytes: Pointer   // ULONGLONG* optional, out
): BOOL; stdcall;
  external 'SHELL32.dll' name 'SHGetDiskFreeSpaceExA';

result := DllCall("SHELL32\SHGetDiskFreeSpaceExA"
    , "AStr", pszDirectoryName   ; LPCSTR
    , "Ptr", pulFreeBytesAvailableToCaller   ; ULONGLONG* optional, out
    , "Ptr", pulTotalNumberOfBytes   ; ULONGLONG* optional, out
    , "Ptr", pulTotalNumberOfFreeBytes   ; ULONGLONG* optional, out
    , "Int")   ; return: BOOL

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