ホーム › Storage.FileSystem › GetDiskFreeSpaceExW

GetDiskFreeSpaceExW

関数

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

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

シグネチャ

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

BOOL GetDiskFreeSpaceExW(
    LPCWSTR lpDirectoryName,   // optional
    ULONGLONG* lpFreeBytesAvailableToCaller,   // optional
    ULONGLONG* lpTotalNumberOfBytes,   // optional
    ULONGLONG* lpTotalNumberOfFreeBytes   // optional
);

パラメーター

名前	型	方向	説明
lpDirectoryName	LPCWSTR	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

公式ドキュメント

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

戻り値

関数が成功した場合、戻り値は 0 以外になります。

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

解説(Remarks)

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

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

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

メモ

fileapi.h ヘッダーは GetDiskFreeSpaceEx を、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして定義しています。エンコーディング中立なエイリアスと、エンコーディング中立でないコードを混在して使用すると、不一致が生じ、コンパイルエラーや実行時エラーの原因となることがあります。詳細については、Conventions for Function Prototypes を参照してください。

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

各言語での呼び出し定義

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

BOOL GetDiskFreeSpaceExW(
    LPCWSTR lpDirectoryName,   // optional
    ULONGLONG* lpFreeBytesAvailableToCaller,   // optional
    ULONGLONG* lpTotalNumberOfBytes,   // optional
    ULONGLONG* lpTotalNumberOfFreeBytes   // optional
);

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

<DllImport("KERNEL32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetDiskFreeSpaceExW(
    <MarshalAs(UnmanagedType.LPWStr)> lpDirectoryName As String,   ' LPCWSTR 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 : LPCWSTR optional
' lpFreeBytesAvailableToCaller : ULONGLONG* optional, out
' lpTotalNumberOfBytes : ULONGLONG* optional, out
' lpTotalNumberOfFreeBytes : ULONGLONG* optional, out
Declare PtrSafe Function GetDiskFreeSpaceExW Lib "kernel32" ( _
    ByVal lpDirectoryName As LongPtr, _
    ByVal lpFreeBytesAvailableToCaller As LongPtr, _
    ByVal lpTotalNumberOfBytes As LongPtr, _
    ByVal lpTotalNumberOfFreeBytes 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

GetDiskFreeSpaceExW = ctypes.windll.kernel32.GetDiskFreeSpaceExW
GetDiskFreeSpaceExW.restype = wintypes.BOOL
GetDiskFreeSpaceExW.argtypes = [
    wintypes.LPCWSTR,  # lpDirectoryName : LPCWSTR 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')
GetDiskFreeSpaceExW = Fiddle::Function.new(
  lib['GetDiskFreeSpaceExW'],
  [
    Fiddle::TYPE_VOIDP,  # lpDirectoryName : LPCWSTR 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)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "kernel32")]
extern "system" {
    fn GetDiskFreeSpaceExW(
        lpDirectoryName: *const u16,  // LPCWSTR 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.Unicode, SetLastError = true)]
public static extern bool GetDiskFreeSpaceExW([MarshalAs(UnmanagedType.LPWStr)] string lpDirectoryName, IntPtr lpFreeBytesAvailableToCaller, IntPtr lpTotalNumberOfBytes, IntPtr lpTotalNumberOfFreeBytes);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_GetDiskFreeSpaceExW' -Namespace Win32 -PassThru
# $api::GetDiskFreeSpaceExW(lpDirectoryName, lpFreeBytesAvailableToCaller, lpTotalNumberOfBytes, lpTotalNumberOfFreeBytes)

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

出力引数:

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