Win32 API 日本語リファレンス
ホーム › Storage.FileSystem › GetDiskSpaceInformationA

GetDiskSpaceInformationA

関数
ボリュームの詳細なディスク領域情報を取得する(ANSI版)。
DLLKERNEL32.dll文字セットANSI (-A)呼出規約winapi
📘 Microsoft Learn (日本語) · English

シグネチャ

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

HRESULT GetDiskSpaceInformationA(
    LPCSTR rootPath,   // optional
    DISK_SPACE_INFORMATION* diskSpaceInfo
);

パラメーター

名前型方向説明
rootPathLPCSTRinoptional

照会するボリュームのルートディレクトリを含む文字列へのポインターです。

このパラメーターが NULL の場合、関数は現在のディスクのルートを使用します。

diskSpaceInfoDISK_SPACE_INFORMATION*out指定されたルートパスにあるボリュームの現在のディスク領域に関する情報を格納する DISK_SPACE_INFORMATION 構造体です。

戻り値の型: HRESULT

公式ドキュメント

指定されたルートパスにあるボリュームのディスク領域情報を取得します。

戻り値

関数が成功した場合は S_OK を返します。失敗した場合は Common HRESULT Values のいずれかの値を返します。拡張エラー情報を取得するには GetLastError を呼び出すことができます。

解説(Remarks)

rootPath には、C:\ や D:\ などのルートパスを指定する必要があり、ルートパスのサブディレクトリを指定することはできません。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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>

HRESULT GetDiskSpaceInformationA(
    LPCSTR rootPath,   // optional
    DISK_SPACE_INFORMATION* diskSpaceInfo
);
[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern int GetDiskSpaceInformationA(
    [MarshalAs(UnmanagedType.LPStr)] string rootPath,   // LPCSTR optional
    IntPtr diskSpaceInfo   // DISK_SPACE_INFORMATION* out
);
<DllImport("KERNEL32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function GetDiskSpaceInformationA(
    <MarshalAs(UnmanagedType.LPStr)> rootPath As String,   ' LPCSTR optional
    diskSpaceInfo As IntPtr   ' DISK_SPACE_INFORMATION* out
) As Integer
End Function
' rootPath : LPCSTR optional
' diskSpaceInfo : DISK_SPACE_INFORMATION* out
Declare PtrSafe Function GetDiskSpaceInformationA Lib "kernel32" ( _
    ByVal rootPath As String, _
    ByVal diskSpaceInfo As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

GetDiskSpaceInformationA = ctypes.windll.kernel32.GetDiskSpaceInformationA
GetDiskSpaceInformationA.restype = ctypes.c_int
GetDiskSpaceInformationA.argtypes = [
    wintypes.LPCSTR,  # rootPath : LPCSTR optional
    ctypes.c_void_p,  # diskSpaceInfo : DISK_SPACE_INFORMATION* out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
GetDiskSpaceInformationA = Fiddle::Function.new(
  lib['GetDiskSpaceInformationA'],
  [
    Fiddle::TYPE_VOIDP,  # rootPath : LPCSTR optional
    Fiddle::TYPE_VOIDP,  # diskSpaceInfo : DISK_SPACE_INFORMATION* out
  ],
  Fiddle::TYPE_INT)
#[link(name = "kernel32")]
extern "system" {
    fn GetDiskSpaceInformationA(
        rootPath: *const u8,  // LPCSTR optional
        diskSpaceInfo: *mut DISK_SPACE_INFORMATION  // DISK_SPACE_INFORMATION* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi)]
public static extern int GetDiskSpaceInformationA([MarshalAs(UnmanagedType.LPStr)] string rootPath, IntPtr diskSpaceInfo);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_GetDiskSpaceInformationA' -Namespace Win32 -PassThru
# $api::GetDiskSpaceInformationA(rootPath, diskSpaceInfo)
#uselib "KERNEL32.dll"
#func global GetDiskSpaceInformationA "GetDiskSpaceInformationA" sptr, sptr
; GetDiskSpaceInformationA rootPath, varptr(diskSpaceInfo)   ; 戻り値は stat
; rootPath : LPCSTR optional -> "sptr"
; diskSpaceInfo : DISK_SPACE_INFORMATION* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数: 
#uselib "KERNEL32.dll"
#cfunc global GetDiskSpaceInformationA "GetDiskSpaceInformationA" str, var
; res = GetDiskSpaceInformationA(rootPath, diskSpaceInfo)
; rootPath : LPCSTR optional -> "str"
; diskSpaceInfo : DISK_SPACE_INFORMATION* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数: 
; HRESULT GetDiskSpaceInformationA(LPCSTR rootPath, DISK_SPACE_INFORMATION* diskSpaceInfo)
#uselib "KERNEL32.dll"
#cfunc global GetDiskSpaceInformationA "GetDiskSpaceInformationA" str, var
; res = GetDiskSpaceInformationA(rootPath, diskSpaceInfo)
; rootPath : LPCSTR optional -> "str"
; diskSpaceInfo : DISK_SPACE_INFORMATION* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procGetDiskSpaceInformationA = kernel32.NewProc("GetDiskSpaceInformationA")
)

// rootPath (LPCSTR optional), diskSpaceInfo (DISK_SPACE_INFORMATION* out)
r1, _, err := procGetDiskSpaceInformationA.Call(
	uintptr(unsafe.Pointer(windows.BytePtrFromString(rootPath))),
	uintptr(diskSpaceInfo),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT
function GetDiskSpaceInformationA(
  rootPath: PAnsiChar;   // LPCSTR optional
  diskSpaceInfo: Pointer   // DISK_SPACE_INFORMATION* out
): Integer; stdcall;
  external 'KERNEL32.dll' name 'GetDiskSpaceInformationA';
result := DllCall("KERNEL32\GetDiskSpaceInformationA"
    , "AStr", rootPath   ; LPCSTR optional
    , "Ptr", diskSpaceInfo   ; DISK_SPACE_INFORMATION* out
    , "Int")   ; return: HRESULT
●GetDiskSpaceInformationA(rootPath, diskSpaceInfo) = DLL("KERNEL32.dll", "int GetDiskSpaceInformationA(char*, void*)")
# 呼び出し: GetDiskSpaceInformationA(rootPath, diskSpaceInfo)
# rootPath : LPCSTR optional -> "char*"
# diskSpaceInfo : DISK_SPACE_INFORMATION* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "kernel32" fn GetDiskSpaceInformationA(
    rootPath: [*c]const u8, // LPCSTR optional
    diskSpaceInfo: [*c]DISK_SPACE_INFORMATION // DISK_SPACE_INFORMATION* out
) callconv(std.os.windows.WINAPI) i32;
proc GetDiskSpaceInformationA(
    rootPath: cstring,  # LPCSTR optional
    diskSpaceInfo: ptr DISK_SPACE_INFORMATION  # DISK_SPACE_INFORMATION* out
): int32 {.importc: "GetDiskSpaceInformationA", stdcall, dynlib: "KERNEL32.dll".}
pragma(lib, "kernel32");
extern(Windows)
int GetDiskSpaceInformationA(
    const(char)* rootPath,   // LPCSTR optional
    DISK_SPACE_INFORMATION* diskSpaceInfo   // DISK_SPACE_INFORMATION* out
);
ccall((:GetDiskSpaceInformationA, "KERNEL32.dll"), stdcall, Int32,
      (Cstring, Ptr{DISK_SPACE_INFORMATION}),
      rootPath, diskSpaceInfo)
# rootPath : LPCSTR optional -> Cstring
# diskSpaceInfo : DISK_SPACE_INFORMATION* out -> Ptr{DISK_SPACE_INFORMATION}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t GetDiskSpaceInformationA(
    const char* rootPath,
    void* diskSpaceInfo);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.GetDiskSpaceInformationA(rootPath, diskSpaceInfo)
-- rootPath : LPCSTR optional
-- diskSpaceInfo : DISK_SPACE_INFORMATION* out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const GetDiskSpaceInformationA = lib.func('__stdcall', 'GetDiskSpaceInformationA', 'int32_t', ['str', 'void *']);
// GetDiskSpaceInformationA(rootPath, diskSpaceInfo)
// rootPath : LPCSTR optional -> 'str'
// diskSpaceInfo : DISK_SPACE_INFORMATION* out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("KERNEL32.dll", {
  GetDiskSpaceInformationA: { parameters: ["buffer", "pointer"], result: "i32" },
});
// lib.symbols.GetDiskSpaceInformationA(rootPath, diskSpaceInfo)
// rootPath : LPCSTR optional -> "buffer"
// diskSpaceInfo : DISK_SPACE_INFORMATION* out -> "pointer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t GetDiskSpaceInformationA(
    const char* rootPath,
    void* diskSpaceInfo);
C, "KERNEL32.dll");
// $ffi->GetDiskSpaceInformationA(rootPath, diskSpaceInfo);
// rootPath : LPCSTR optional
// diskSpaceInfo : DISK_SPACE_INFORMATION* 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 Kernel32 extends StdCallLibrary {
    Kernel32 INSTANCE = Native.load("kernel32", Kernel32.class, W32APIOptions.ASCII_OPTIONS);
    int GetDiskSpaceInformationA(
        String rootPath,   // LPCSTR optional
        Pointer diskSpaceInfo   // DISK_SPACE_INFORMATION* out
    );
}
@[Link("kernel32")]
lib LibKERNEL32
  fun GetDiskSpaceInformationA = GetDiskSpaceInformationA(
    rootPath : UInt8*,   # LPCSTR optional
    diskSpaceInfo : DISK_SPACE_INFORMATION*   # DISK_SPACE_INFORMATION* out
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef GetDiskSpaceInformationANative = Int32 Function(Pointer<Utf8>, Pointer<Void>);
typedef GetDiskSpaceInformationADart = int Function(Pointer<Utf8>, Pointer<Void>);
final GetDiskSpaceInformationA = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<GetDiskSpaceInformationANative, GetDiskSpaceInformationADart>('GetDiskSpaceInformationA');
// rootPath : LPCSTR optional -> Pointer<Utf8>
// diskSpaceInfo : DISK_SPACE_INFORMATION* out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function GetDiskSpaceInformationA(
  rootPath: PAnsiChar;   // LPCSTR optional
  diskSpaceInfo: Pointer   // DISK_SPACE_INFORMATION* out
): Integer; stdcall;
  external 'KERNEL32.dll' name 'GetDiskSpaceInformationA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "GetDiskSpaceInformationA"
  c_GetDiskSpaceInformationA :: CString -> Ptr () -> IO Int32
-- rootPath : LPCSTR optional -> CString
-- diskSpaceInfo : DISK_SPACE_INFORMATION* out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let getdiskspaceinformationa =
  foreign "GetDiskSpaceInformationA"
    (string @-> (ptr void) @-> returning int32_t)
(* rootPath : LPCSTR optional -> string *)
(* diskSpaceInfo : DISK_SPACE_INFORMATION* out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("GetDiskSpaceInformationA" get-disk-space-information-a :convention :stdcall) :int32
  (root-path :string)   ; LPCSTR optional
  (disk-space-info :pointer))   ; DISK_SPACE_INFORMATION* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $GetDiskSpaceInformationA = Win32::API::More->new('KERNEL32',
    'int GetDiskSpaceInformationA(LPCSTR rootPath, LPVOID diskSpaceInfo)');
# my $ret = $GetDiskSpaceInformationA->Call($rootPath, $diskSpaceInfo);
# rootPath : LPCSTR optional -> LPCSTR
# diskSpaceInfo : DISK_SPACE_INFORMATION* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い
使用する型