SHGetDiskFreeSpaceExW
関数指定ディレクトリのディスク空き容量と総容量を取得する。
シグネチャ
// SHELL32.dll (Unicode / -W)
#include <windows.h>
BOOL SHGetDiskFreeSpaceExW(
LPCWSTR pszDirectoryName,
ULONGLONG* pulFreeBytesAvailableToCaller, // optional
ULONGLONG* pulTotalNumberOfBytes, // optional
ULONGLONG* pulTotalNumberOfFreeBytes // optional
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| pszDirectoryName | LPCWSTR | in | サイズ情報を取得する対象のボリュームを指定する null 終端文字列です。ドライブ文字、UNC 名、またはフォルダーのパスを指定できます。現在のドライブを表すために NULL を使用することはできません。 |
| pulFreeBytesAvailableToCaller | ULONGLONG* | outoptional | 呼び出し元アプリケーションが利用可能なボリューム上のバイト数を受け取る値へのポインターです。オペレーティングシステムがユーザーごとのクォータを実装している場合、この値はボリューム上の空きバイトの総数より小さくなることがあります。 |
| pulTotalNumberOfBytes | ULONGLONG* | outoptional | ボリュームの合計サイズ(バイト単位)を受け取る値へのポインターです。 |
| pulTotalNumberOfFreeBytes | ULONGLONG* | outoptional | ボリューム上の空き領域のバイト数を受け取る値へのポインターです。 |
戻り値の型: BOOL
公式ドキュメント
ディスクボリュームのディスク領域情報を取得します。(Unicode)
戻り値
型: 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)
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// SHELL32.dll (Unicode / -W)
#include <windows.h>
BOOL SHGetDiskFreeSpaceExW(
LPCWSTR pszDirectoryName,
ULONGLONG* pulFreeBytesAvailableToCaller, // optional
ULONGLONG* pulTotalNumberOfBytes, // optional
ULONGLONG* pulTotalNumberOfFreeBytes // optional
);[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SHELL32.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern bool SHGetDiskFreeSpaceExW(
[MarshalAs(UnmanagedType.LPWStr)] string pszDirectoryName, // LPCWSTR
IntPtr pulFreeBytesAvailableToCaller, // ULONGLONG* optional, out
IntPtr pulTotalNumberOfBytes, // ULONGLONG* optional, out
IntPtr pulTotalNumberOfFreeBytes // ULONGLONG* optional, out
);<DllImport("SHELL32.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function SHGetDiskFreeSpaceExW(
<MarshalAs(UnmanagedType.LPWStr)> pszDirectoryName As String, ' LPCWSTR
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 : LPCWSTR
' pulFreeBytesAvailableToCaller : ULONGLONG* optional, out
' pulTotalNumberOfBytes : ULONGLONG* optional, out
' pulTotalNumberOfFreeBytes : ULONGLONG* optional, out
Declare PtrSafe Function SHGetDiskFreeSpaceExW Lib "shell32" ( _
ByVal pszDirectoryName As LongPtr, _
ByVal pulFreeBytesAvailableToCaller As LongPtr, _
ByVal pulTotalNumberOfBytes As LongPtr, _
ByVal pulTotalNumberOfFreeBytes 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
SHGetDiskFreeSpaceExW = ctypes.windll.shell32.SHGetDiskFreeSpaceExW
SHGetDiskFreeSpaceExW.restype = wintypes.BOOL
SHGetDiskFreeSpaceExW.argtypes = [
wintypes.LPCWSTR, # pszDirectoryName : LPCWSTR
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')
SHGetDiskFreeSpaceExW = Fiddle::Function.new(
lib['SHGetDiskFreeSpaceExW'],
[
Fiddle::TYPE_VOIDP, # pszDirectoryName : LPCWSTR
Fiddle::TYPE_VOIDP, # pulFreeBytesAvailableToCaller : ULONGLONG* optional, out
Fiddle::TYPE_VOIDP, # pulTotalNumberOfBytes : ULONGLONG* optional, out
Fiddle::TYPE_VOIDP, # pulTotalNumberOfFreeBytes : ULONGLONG* optional, out
],
Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"#[link(name = "shell32")]
extern "system" {
fn SHGetDiskFreeSpaceExW(
pszDirectoryName: *const u16, // LPCWSTR
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.Unicode)]
public static extern bool SHGetDiskFreeSpaceExW([MarshalAs(UnmanagedType.LPWStr)] string pszDirectoryName, IntPtr pulFreeBytesAvailableToCaller, IntPtr pulTotalNumberOfBytes, IntPtr pulTotalNumberOfFreeBytes);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHELL32_SHGetDiskFreeSpaceExW' -Namespace Win32 -PassThru
# $api::SHGetDiskFreeSpaceExW(pszDirectoryName, pulFreeBytesAvailableToCaller, pulTotalNumberOfBytes, pulTotalNumberOfFreeBytes)#uselib "SHELL32.dll"
#func global SHGetDiskFreeSpaceExW "SHGetDiskFreeSpaceExW" wptr, wptr, wptr, wptr
; SHGetDiskFreeSpaceExW pszDirectoryName, varptr(pulFreeBytesAvailableToCaller), varptr(pulTotalNumberOfBytes), varptr(pulTotalNumberOfFreeBytes) ; 戻り値は stat
; pszDirectoryName : LPCWSTR -> "wptr"
; pulFreeBytesAvailableToCaller : ULONGLONG* optional, out -> "wptr"
; pulTotalNumberOfBytes : ULONGLONG* optional, out -> "wptr"
; pulTotalNumberOfFreeBytes : ULONGLONG* optional, out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。出力引数:
#uselib "SHELL32.dll" #cfunc global SHGetDiskFreeSpaceExW "SHGetDiskFreeSpaceExW" wstr, var, var, var ; res = SHGetDiskFreeSpaceExW(pszDirectoryName, pulFreeBytesAvailableToCaller, pulTotalNumberOfBytes, pulTotalNumberOfFreeBytes) ; pszDirectoryName : LPCWSTR -> "wstr" ; pulFreeBytesAvailableToCaller : ULONGLONG* optional, out -> "var" ; pulTotalNumberOfBytes : ULONGLONG* optional, out -> "var" ; pulTotalNumberOfFreeBytes : ULONGLONG* optional, out -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "SHELL32.dll" #cfunc global SHGetDiskFreeSpaceExW "SHGetDiskFreeSpaceExW" wstr, sptr, sptr, sptr ; res = SHGetDiskFreeSpaceExW(pszDirectoryName, varptr(pulFreeBytesAvailableToCaller), varptr(pulTotalNumberOfBytes), varptr(pulTotalNumberOfFreeBytes)) ; pszDirectoryName : LPCWSTR -> "wstr" ; pulFreeBytesAvailableToCaller : ULONGLONG* optional, out -> "sptr" ; pulTotalNumberOfBytes : ULONGLONG* optional, out -> "sptr" ; pulTotalNumberOfFreeBytes : ULONGLONG* optional, out -> "sptr" ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
出力引数:
; BOOL SHGetDiskFreeSpaceExW(LPCWSTR pszDirectoryName, ULONGLONG* pulFreeBytesAvailableToCaller, ULONGLONG* pulTotalNumberOfBytes, ULONGLONG* pulTotalNumberOfFreeBytes) #uselib "SHELL32.dll" #cfunc global SHGetDiskFreeSpaceExW "SHGetDiskFreeSpaceExW" wstr, var, var, var ; res = SHGetDiskFreeSpaceExW(pszDirectoryName, pulFreeBytesAvailableToCaller, pulTotalNumberOfBytes, pulTotalNumberOfFreeBytes) ; pszDirectoryName : LPCWSTR -> "wstr" ; pulFreeBytesAvailableToCaller : ULONGLONG* optional, out -> "var" ; pulTotalNumberOfBytes : ULONGLONG* optional, out -> "var" ; pulTotalNumberOfFreeBytes : ULONGLONG* optional, out -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; BOOL SHGetDiskFreeSpaceExW(LPCWSTR pszDirectoryName, ULONGLONG* pulFreeBytesAvailableToCaller, ULONGLONG* pulTotalNumberOfBytes, ULONGLONG* pulTotalNumberOfFreeBytes) #uselib "SHELL32.dll" #cfunc global SHGetDiskFreeSpaceExW "SHGetDiskFreeSpaceExW" wstr, intptr, intptr, intptr ; res = SHGetDiskFreeSpaceExW(pszDirectoryName, varptr(pulFreeBytesAvailableToCaller), varptr(pulTotalNumberOfBytes), varptr(pulTotalNumberOfFreeBytes)) ; pszDirectoryName : LPCWSTR -> "wstr" ; 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")
procSHGetDiskFreeSpaceExW = shell32.NewProc("SHGetDiskFreeSpaceExW")
)
// pszDirectoryName (LPCWSTR), pulFreeBytesAvailableToCaller (ULONGLONG* optional, out), pulTotalNumberOfBytes (ULONGLONG* optional, out), pulTotalNumberOfFreeBytes (ULONGLONG* optional, out)
r1, _, err := procSHGetDiskFreeSpaceExW.Call(
uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(pszDirectoryName))),
uintptr(pulFreeBytesAvailableToCaller),
uintptr(pulTotalNumberOfBytes),
uintptr(pulTotalNumberOfFreeBytes),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // BOOLfunction SHGetDiskFreeSpaceExW(
pszDirectoryName: PWideChar; // LPCWSTR
pulFreeBytesAvailableToCaller: Pointer; // ULONGLONG* optional, out
pulTotalNumberOfBytes: Pointer; // ULONGLONG* optional, out
pulTotalNumberOfFreeBytes: Pointer // ULONGLONG* optional, out
): BOOL; stdcall;
external 'SHELL32.dll' name 'SHGetDiskFreeSpaceExW';result := DllCall("SHELL32\SHGetDiskFreeSpaceExW"
, "WStr", pszDirectoryName ; LPCWSTR
, "Ptr", pulFreeBytesAvailableToCaller ; ULONGLONG* optional, out
, "Ptr", pulTotalNumberOfBytes ; ULONGLONG* optional, out
, "Ptr", pulTotalNumberOfFreeBytes ; ULONGLONG* optional, out
, "Int") ; return: BOOL●SHGetDiskFreeSpaceExW(pszDirectoryName, pulFreeBytesAvailableToCaller, pulTotalNumberOfBytes, pulTotalNumberOfFreeBytes) = DLL("SHELL32.dll", "bool SHGetDiskFreeSpaceExW(char*, void*, void*, void*)")
# 呼び出し: SHGetDiskFreeSpaceExW(pszDirectoryName, pulFreeBytesAvailableToCaller, pulTotalNumberOfBytes, pulTotalNumberOfFreeBytes)
# pszDirectoryName : LPCWSTR -> "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)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。const std = @import("std");
extern "shell32" fn SHGetDiskFreeSpaceExW(
pszDirectoryName: [*c]const u16, // LPCWSTR
pulFreeBytesAvailableToCaller: [*c]u64, // ULONGLONG* optional, out
pulTotalNumberOfBytes: [*c]u64, // ULONGLONG* optional, out
pulTotalNumberOfFreeBytes: [*c]u64 // ULONGLONG* optional, out
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。proc SHGetDiskFreeSpaceExW(
pszDirectoryName: WideCString, # LPCWSTR
pulFreeBytesAvailableToCaller: ptr uint64, # ULONGLONG* optional, out
pulTotalNumberOfBytes: ptr uint64, # ULONGLONG* optional, out
pulTotalNumberOfFreeBytes: ptr uint64 # ULONGLONG* optional, out
): int32 {.importc: "SHGetDiskFreeSpaceExW", stdcall, dynlib: "SHELL32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。pragma(lib, "shell32");
extern(Windows)
int SHGetDiskFreeSpaceExW(
const(wchar)* pszDirectoryName, // LPCWSTR
ulong* pulFreeBytesAvailableToCaller, // ULONGLONG* optional, out
ulong* pulTotalNumberOfBytes, // ULONGLONG* optional, out
ulong* pulTotalNumberOfFreeBytes // ULONGLONG* optional, out
);ccall((:SHGetDiskFreeSpaceExW, "SHELL32.dll"), stdcall, Int32,
(Cwstring, Ptr{UInt64}, Ptr{UInt64}, Ptr{UInt64}),
pszDirectoryName, pulFreeBytesAvailableToCaller, pulTotalNumberOfBytes, pulTotalNumberOfFreeBytes)
# pszDirectoryName : LPCWSTR -> Cwstring
# pulFreeBytesAvailableToCaller : ULONGLONG* optional, out -> Ptr{UInt64}
# pulTotalNumberOfBytes : ULONGLONG* optional, out -> Ptr{UInt64}
# pulTotalNumberOfFreeBytes : ULONGLONG* optional, out -> Ptr{UInt64}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。local ffi = require("ffi")
ffi.cdef[[
int32_t SHGetDiskFreeSpaceExW(
const uint16_t* pszDirectoryName,
uint64_t* pulFreeBytesAvailableToCaller,
uint64_t* pulTotalNumberOfBytes,
uint64_t* pulTotalNumberOfFreeBytes);
]]
local shell32 = ffi.load("shell32")
-- shell32.SHGetDiskFreeSpaceExW(pszDirectoryName, pulFreeBytesAvailableToCaller, pulTotalNumberOfBytes, pulTotalNumberOfFreeBytes)
-- pszDirectoryName : LPCWSTR
-- pulFreeBytesAvailableToCaller : ULONGLONG* optional, out
-- pulTotalNumberOfBytes : ULONGLONG* optional, out
-- pulTotalNumberOfFreeBytes : ULONGLONG* optional, out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。const koffi = require('koffi');
const lib = koffi.load('SHELL32.dll');
const SHGetDiskFreeSpaceExW = lib.func('__stdcall', 'SHGetDiskFreeSpaceExW', 'int32_t', ['str16', 'uint64_t *', 'uint64_t *', 'uint64_t *']);
// SHGetDiskFreeSpaceExW(pszDirectoryName, pulFreeBytesAvailableToCaller, pulTotalNumberOfBytes, pulTotalNumberOfFreeBytes)
// pszDirectoryName : LPCWSTR -> 'str16'
// pulFreeBytesAvailableToCaller : ULONGLONG* optional, out -> 'uint64_t *'
// pulTotalNumberOfBytes : ULONGLONG* optional, out -> 'uint64_t *'
// pulTotalNumberOfFreeBytes : ULONGLONG* optional, out -> 'uint64_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("SHELL32.dll", {
SHGetDiskFreeSpaceExW: { parameters: ["buffer", "pointer", "pointer", "pointer"], result: "i32" },
});
// lib.symbols.SHGetDiskFreeSpaceExW(pszDirectoryName, pulFreeBytesAvailableToCaller, pulTotalNumberOfBytes, pulTotalNumberOfFreeBytes)
// pszDirectoryName : LPCWSTR -> "buffer"
// pulFreeBytesAvailableToCaller : ULONGLONG* optional, out -> "pointer"
// pulTotalNumberOfBytes : ULONGLONG* optional, out -> "pointer"
// pulTotalNumberOfFreeBytes : ULONGLONG* optional, out -> "pointer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t SHGetDiskFreeSpaceExW(
const uint16_t* pszDirectoryName,
uint64_t* pulFreeBytesAvailableToCaller,
uint64_t* pulTotalNumberOfBytes,
uint64_t* pulTotalNumberOfFreeBytes);
C, "SHELL32.dll");
// $ffi->SHGetDiskFreeSpaceExW(pszDirectoryName, pulFreeBytesAvailableToCaller, pulTotalNumberOfBytes, pulTotalNumberOfFreeBytes);
// pszDirectoryName : LPCWSTR
// pulFreeBytesAvailableToCaller : ULONGLONG* optional, out
// pulTotalNumberOfBytes : ULONGLONG* optional, out
// pulTotalNumberOfFreeBytes : ULONGLONG* optional, out
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;
public interface Shell32 extends StdCallLibrary {
Shell32 INSTANCE = Native.load("shell32", Shell32.class, W32APIOptions.UNICODE_OPTIONS);
boolean SHGetDiskFreeSpaceExW(
WString pszDirectoryName, // LPCWSTR
LongByReference pulFreeBytesAvailableToCaller, // ULONGLONG* optional, out
LongByReference pulTotalNumberOfBytes, // ULONGLONG* optional, out
LongByReference pulTotalNumberOfFreeBytes // ULONGLONG* optional, out
);
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。@[Link("shell32")]
lib LibSHELL32
fun SHGetDiskFreeSpaceExW = SHGetDiskFreeSpaceExW(
pszDirectoryName : UInt16*, # LPCWSTR
pulFreeBytesAvailableToCaller : UInt64*, # ULONGLONG* optional, out
pulTotalNumberOfBytes : UInt64*, # ULONGLONG* optional, out
pulTotalNumberOfFreeBytes : UInt64* # ULONGLONG* optional, out
) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef SHGetDiskFreeSpaceExWNative = Int32 Function(Pointer<Utf16>, Pointer<Uint64>, Pointer<Uint64>, Pointer<Uint64>);
typedef SHGetDiskFreeSpaceExWDart = int Function(Pointer<Utf16>, Pointer<Uint64>, Pointer<Uint64>, Pointer<Uint64>);
final SHGetDiskFreeSpaceExW = DynamicLibrary.open('SHELL32.dll')
.lookupFunction<SHGetDiskFreeSpaceExWNative, SHGetDiskFreeSpaceExWDart>('SHGetDiskFreeSpaceExW');
// pszDirectoryName : LPCWSTR -> Pointer<Utf16>
// pulFreeBytesAvailableToCaller : ULONGLONG* optional, out -> Pointer<Uint64>
// pulTotalNumberOfBytes : ULONGLONG* optional, out -> Pointer<Uint64>
// pulTotalNumberOfFreeBytes : ULONGLONG* optional, out -> Pointer<Uint64>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function SHGetDiskFreeSpaceExW(
pszDirectoryName: PWideChar; // LPCWSTR
pulFreeBytesAvailableToCaller: Pointer; // ULONGLONG* optional, out
pulTotalNumberOfBytes: Pointer; // ULONGLONG* optional, out
pulTotalNumberOfFreeBytes: Pointer // ULONGLONG* optional, out
): BOOL; stdcall;
external 'SHELL32.dll' name 'SHGetDiskFreeSpaceExW';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "SHGetDiskFreeSpaceExW"
c_SHGetDiskFreeSpaceExW :: CWString -> Ptr Word64 -> Ptr Word64 -> Ptr Word64 -> IO CInt
-- pszDirectoryName : LPCWSTR -> CWString
-- pulFreeBytesAvailableToCaller : ULONGLONG* optional, out -> Ptr Word64
-- pulTotalNumberOfBytes : ULONGLONG* optional, out -> Ptr Word64
-- pulTotalNumberOfFreeBytes : ULONGLONG* optional, out -> Ptr Word64
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let shgetdiskfreespaceexw =
foreign "SHGetDiskFreeSpaceExW"
((ptr uint16_t) @-> (ptr uint64_t) @-> (ptr uint64_t) @-> (ptr uint64_t) @-> returning int32_t)
(* pszDirectoryName : LPCWSTR -> (ptr uint16_t) *)
(* pulFreeBytesAvailableToCaller : ULONGLONG* optional, out -> (ptr uint64_t) *)
(* pulTotalNumberOfBytes : ULONGLONG* optional, out -> (ptr uint64_t) *)
(* pulTotalNumberOfFreeBytes : ULONGLONG* optional, out -> (ptr uint64_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library shell32 (t "SHELL32.dll"))
(cffi:use-foreign-library shell32)
(cffi:defcfun ("SHGetDiskFreeSpaceExW" shget-disk-free-space-ex-w :convention :stdcall) :int32
(psz-directory-name (:string :encoding :utf-16le)) ; LPCWSTR
(pul-free-bytes-available-to-caller :pointer) ; ULONGLONG* optional, out
(pul-total-number-of-bytes :pointer) ; ULONGLONG* optional, out
(pul-total-number-of-free-bytes :pointer)) ; ULONGLONG* optional, out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $SHGetDiskFreeSpaceExW = Win32::API::More->new('SHELL32',
'BOOL SHGetDiskFreeSpaceExW(LPCWSTR pszDirectoryName, LPVOID pulFreeBytesAvailableToCaller, LPVOID pulTotalNumberOfBytes, LPVOID pulTotalNumberOfFreeBytes)');
# my $ret = $SHGetDiskFreeSpaceExW->Call($pszDirectoryName, $pulFreeBytesAvailableToCaller, $pulTotalNumberOfBytes, $pulTotalNumberOfFreeBytes);
# pszDirectoryName : LPCWSTR -> LPCWSTR
# pulFreeBytesAvailableToCaller : ULONGLONG* optional, out -> LPVOID
# pulTotalNumberOfBytes : ULONGLONG* optional, out -> LPVOID
# pulTotalNumberOfFreeBytes : ULONGLONG* optional, out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。関連項目
文字セット違い
- f SHGetDiskFreeSpaceExA (ANSI版) — 指定ディレクトリのディスク空き容量と総容量を取得する。
公式の関連項目
- f GetDiskFreeSpaceExW — ディスクの総容量と空き容量をバイト単位で取得する。