ホーム › 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	サイズ情報を取得する対象のボリュームを指定する、null 終端文字列です。ドライブ文字、UNC 名、またはフォルダーのパスを指定できます。現在のドライブを表すために NULL を使用することはできません。
pulFreeBytesAvailableToCaller	ULONGLONG*	outoptional	呼び出し元のアプリケーションが使用可能なボリューム上のバイト数を受け取る値へのポインターです。オペレーティングシステムがユーザーごとのクォータを実装している場合、この値はボリューム上の空きバイト総数より小さくなることがあります。
pulTotalNumberOfBytes	ULONGLONG*	outoptional	ボリュームの合計サイズ(バイト単位)を受け取る値へのポインターです。
pulTotalNumberOfFreeBytes	ULONGLONG*	outoptional	ボリューム上の空き領域のバイト数を受け取る値へのポインターです。

戻り値の型: BOOL

公式ドキュメント

ディスクボリュームのディスク容量情報を取得します。(ANSI)

戻り値

型: BOOL

成功した場合は TRUE を、それ以外の場合は FALSE を返します。

解説(Remarks)

似た名前の関数 SHGetDiskFreeSpace は、単に SHGetDiskFreeSpaceEx のエイリアスです。SHGetDiskFreeSpace を呼び出すと、実際にはこの関数が呼び出されます。

この関数は、オペレーティングシステムで GetDiskFreeSpaceEx 関数が利用可能な場合はそれを呼び出します。GetDiskFreeSpaceEx が利用できない場合は、GetDiskFreeSpace 関数を呼び出して戻り値を操作することでエミュレートされます。詳細については、GetDiskFreeSpaceEx のドキュメントを参照してください。

メモ

shellapi.h ヘッダーは、SHGetDiskFreeSpaceEx を、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)

各言語での呼び出し定義

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