ホーム › Storage.FileSystem › GetDiskFreeSpaceA

GetDiskFreeSpaceA

関数

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

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

シグネチャ

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

BOOL GetDiskFreeSpaceA(
    LPCSTR lpRootPathName,   // optional
    DWORD* lpSectorsPerCluster,   // optional
    DWORD* lpBytesPerSector,   // optional
    DWORD* lpNumberOfFreeClusters,   // optional
    DWORD* lpTotalNumberOfClusters   // optional
);

パラメーター

名前	型	方向	説明
lpRootPathName	LPCSTR	inoptional	情報を返す対象となるディスクのルートディレクトリ。このパラメーターが NULL の場合、関数は現在のディスクのルートを使用します。このパラメーターが UNC 名の場合は、末尾にバックスラッシュを含める必要があります(例: "\\MyServer\MyShare\")。さらに、ドライブ指定には末尾のバックスラッシュが必要です(例: "C:\")。呼び出し元のアプリケーションは、このディレクトリに対して FILE_LIST_DIRECTORY アクセス権を持っている必要があります。
lpSectorsPerCluster	DWORD*	outoptional	クラスターあたりのセクター数を受け取る変数へのポインター。
lpBytesPerSector	DWORD*	outoptional	セクターあたりのバイト数を受け取る変数へのポインター。
lpNumberOfFreeClusters	DWORD*	outoptional	呼び出し元のスレッドに関連付けられているユーザーが利用できる、ディスク上の空きクラスターの総数を受け取る変数へのポインター。ユーザーごとのディスククォータが使用されている場合、この値はディスク上の空きクラスターの総数より少なくなることがあります。
lpTotalNumberOfClusters	DWORD*	outoptional	呼び出し元のスレッドに関連付けられているユーザーが利用できる、ディスク上のクラスターの総数を受け取る変数へのポインター。ユーザーごとのディスククォータが使用されている場合、この値はディスク上のクラスターの総数より少なくなることがあります。

戻り値の型: BOOL

公式ドキュメント

指定したディスクに関する情報(ディスク上の空き領域の量を含む)を取得します。(ANSI)

戻り値

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

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

解説(Remarks)

GetDiskFreeSpaceEx 関数を使用すると、 GetDiskFreeSpace 関数で必要となる算術計算の一部を回避できます。

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

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 GetDiskFreeSpaceA(
    LPCSTR lpRootPathName,   // optional
    DWORD* lpSectorsPerCluster,   // optional
    DWORD* lpBytesPerSector,   // optional
    DWORD* lpNumberOfFreeClusters,   // optional
    DWORD* lpTotalNumberOfClusters   // optional
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool GetDiskFreeSpaceA(
    [MarshalAs(UnmanagedType.LPStr)] string lpRootPathName,   // LPCSTR 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.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetDiskFreeSpaceA(
    <MarshalAs(UnmanagedType.LPStr)> lpRootPathName As String,   ' LPCSTR 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 <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' lpRootPathName : LPCSTR optional
' lpSectorsPerCluster : DWORD* optional, out
' lpBytesPerSector : DWORD* optional, out
' lpNumberOfFreeClusters : DWORD* optional, out
' lpTotalNumberOfClusters : DWORD* optional, out
Declare PtrSafe Function GetDiskFreeSpaceA Lib "kernel32" ( _
    ByVal lpRootPathName As String, _
    ByVal lpSectorsPerCluster As LongPtr, _
    ByVal lpBytesPerSector As LongPtr, _
    ByVal lpNumberOfFreeClusters As LongPtr, _
    ByVal lpTotalNumberOfClusters As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetDiskFreeSpaceA = ctypes.windll.kernel32.GetDiskFreeSpaceA
GetDiskFreeSpaceA.restype = wintypes.BOOL
GetDiskFreeSpaceA.argtypes = [
    wintypes.LPCSTR,  # lpRootPathName : LPCSTR 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')
GetDiskFreeSpaceA = Fiddle::Function.new(
  lib['GetDiskFreeSpaceA'],
  [
    Fiddle::TYPE_VOIDP,  # lpRootPathName : LPCSTR 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)

#[link(name = "kernel32")]
extern "system" {
    fn GetDiskFreeSpaceA(
        lpRootPathName: *const u8,  // LPCSTR 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.Ansi, SetLastError = true)]
public static extern bool GetDiskFreeSpaceA([MarshalAs(UnmanagedType.LPStr)] string lpRootPathName, IntPtr lpSectorsPerCluster, IntPtr lpBytesPerSector, IntPtr lpNumberOfFreeClusters, IntPtr lpTotalNumberOfClusters);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_GetDiskFreeSpaceA' -Namespace Win32 -PassThru
# $api::GetDiskFreeSpaceA(lpRootPathName, lpSectorsPerCluster, lpBytesPerSector, lpNumberOfFreeClusters, lpTotalNumberOfClusters)

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

出力引数:

#uselib "KERNEL32.dll"
#cfunc global GetDiskFreeSpaceA "GetDiskFreeSpaceA" str, var, var, var, var
; res = GetDiskFreeSpaceA(lpRootPathName, lpSectorsPerCluster, lpBytesPerSector, lpNumberOfFreeClusters, lpTotalNumberOfClusters)
; lpRootPathName : LPCSTR optional -> "str"
; 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 GetDiskFreeSpaceA "GetDiskFreeSpaceA" str, sptr, sptr, sptr, sptr
; res = GetDiskFreeSpaceA(lpRootPathName, varptr(lpSectorsPerCluster), varptr(lpBytesPerSector), varptr(lpNumberOfFreeClusters), varptr(lpTotalNumberOfClusters))
; lpRootPathName : LPCSTR optional -> "str"
; lpSectorsPerCluster : DWORD* optional, out -> "sptr"
; lpBytesPerSector : DWORD* optional, out -> "sptr"
; lpNumberOfFreeClusters : DWORD* optional, out -> "sptr"
; lpTotalNumberOfClusters : DWORD* optional, out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。