ホーム › 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	ディスク上のディレクトリ。このパラメーターが NULL の場合、関数は現在のディスクのルートを使用します。このパラメーターが UNC 名の場合、末尾にバックスラッシュを含める必要があります。例: "\\MyServer\MyShare\"。このパラメーターはディスクのルートディレクトリを指定する必要はありません。関数はディスク上の任意のディレクトリを受け付けます。呼び出し側アプリケーションは、このディレクトリに対する FILE_LIST_DIRECTORY アクセス権を持っている必要があります。
lpFreeBytesAvailableToCaller	ULONGLONG*	outoptional	呼び出しスレッドに関連付けられたユーザーが利用可能な、ディスク上の空きバイトの総数を受け取る変数へのポインター。このパラメーターは NULL にすることができます。ユーザーごとのクォータが使用されている場合、この値はディスク上の空きバイトの総数より少なくなることがあります。
lpTotalNumberOfBytes	ULONGLONG*	outoptional	呼び出しスレッドに関連付けられたユーザーが利用可能な、ディスク上のバイトの総数を受け取る変数へのポインター。このパラメーターは NULL にすることができます。ユーザーごとのクォータが使用されている場合、この値はディスク上のバイトの総数より少なくなることがあります。ディスクまたはボリューム上のバイトの総数を確認するには、 IOCTL_DISK_GET_LENGTH_INFO を使用してください。
lpTotalNumberOfFreeBytes	ULONGLONG*	outoptional	ディスク上の空きバイトの総数を受け取る変数へのポインター。このパラメーターは NULL にすることができます。

戻り値の型: BOOL

公式ドキュメント

ディスクボリューム上で利用可能な領域に関する情報、すなわちディスクの総容量、空き領域の総量、および呼び出しスレッドに関連付けられたユーザーが利用可能な空き領域の総量を取得します。(ANSI)

戻り値

関数が成功した場合、戻り値は 0 以外の値です。

関数が失敗した場合、戻り値は 0 です。拡張エラー情報を取得するには、 GetLastError を呼び出してください。

解説(Remarks)

この関数で取得される値は ULARGE_INTEGER 型です。これらの値を 32 ビットに切り詰めないでください。

GetDiskFreeSpaceEx 関数は、ディスクが CD-RW ドライブ内の未書き込みの CD でない限り、すべての CD 要求に対して lpTotalNumberOfFreeBytes および lpFreeBytesAvailable に 0 を返します。

シンボリックリンクの動作 — パスがシンボリックリンクを指している場合、操作はリンク先に対して実行されます。

メモ

fileapi.h ヘッダーは GetDiskFreeSpaceEx を、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして定義しています。エンコーディング非依存のエイリアスを、エンコーディング非依存でないコードと混在させて使用すると、不一致が生じ、コンパイルエラーや実行時エラーを引き起こす可能性があります。詳細については、関数プロトタイプの規約を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// 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 <MarshalAs(UnmanagedType.Bool)> 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(変数))。