ホーム › Storage.FileSystem › GetDiskSpaceInformationW
GetDiskSpaceInformationW
関数ボリュームの詳細なディスク領域情報を取得する。
シグネチャ
// KERNEL32.dll (Unicode / -W)
#include <windows.h>
HRESULT GetDiskSpaceInformationW(
LPCWSTR rootPath, // optional
DISK_SPACE_INFORMATION* diskSpaceInfo
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| rootPath | LPCWSTR | inoptional | 照会対象のボリュームのルートディレクトリを格納した文字列へのポインターです。 このパラメーターが |
| diskSpaceInfo | DISK_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)
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// KERNEL32.dll (Unicode / -W)
#include <windows.h>
HRESULT GetDiskSpaceInformationW(
LPCWSTR rootPath, // optional
DISK_SPACE_INFORMATION* diskSpaceInfo
);[DllImport("KERNEL32.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern int GetDiskSpaceInformationW(
[MarshalAs(UnmanagedType.LPWStr)] string rootPath, // LPCWSTR optional
IntPtr diskSpaceInfo // DISK_SPACE_INFORMATION* out
);<DllImport("KERNEL32.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function GetDiskSpaceInformationW(
<MarshalAs(UnmanagedType.LPWStr)> rootPath As String, ' LPCWSTR optional
diskSpaceInfo As IntPtr ' DISK_SPACE_INFORMATION* out
) As Integer
End Function' rootPath : LPCWSTR optional
' diskSpaceInfo : DISK_SPACE_INFORMATION* out
Declare PtrSafe Function GetDiskSpaceInformationW Lib "kernel32" ( _
ByVal rootPath As LongPtr, _
ByVal diskSpaceInfo 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
GetDiskSpaceInformationW = ctypes.windll.kernel32.GetDiskSpaceInformationW
GetDiskSpaceInformationW.restype = ctypes.c_int
GetDiskSpaceInformationW.argtypes = [
wintypes.LPCWSTR, # rootPath : LPCWSTR optional
ctypes.c_void_p, # diskSpaceInfo : DISK_SPACE_INFORMATION* out
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('KERNEL32.dll')
GetDiskSpaceInformationW = Fiddle::Function.new(
lib['GetDiskSpaceInformationW'],
[
Fiddle::TYPE_VOIDP, # rootPath : LPCWSTR optional
Fiddle::TYPE_VOIDP, # diskSpaceInfo : DISK_SPACE_INFORMATION* out
],
Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"#[link(name = "kernel32")]
extern "system" {
fn GetDiskSpaceInformationW(
rootPath: *const u16, // LPCWSTR 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.Unicode)]
public static extern int GetDiskSpaceInformationW([MarshalAs(UnmanagedType.LPWStr)] string rootPath, IntPtr diskSpaceInfo);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_GetDiskSpaceInformationW' -Namespace Win32 -PassThru
# $api::GetDiskSpaceInformationW(rootPath, diskSpaceInfo)#uselib "KERNEL32.dll"
#func global GetDiskSpaceInformationW "GetDiskSpaceInformationW" wptr, wptr
; GetDiskSpaceInformationW rootPath, varptr(diskSpaceInfo) ; 戻り値は stat
; rootPath : LPCWSTR optional -> "wptr"
; diskSpaceInfo : DISK_SPACE_INFORMATION* out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。出力引数:
#uselib "KERNEL32.dll" #cfunc global GetDiskSpaceInformationW "GetDiskSpaceInformationW" wstr, var ; res = GetDiskSpaceInformationW(rootPath, diskSpaceInfo) ; rootPath : LPCWSTR optional -> "wstr" ; diskSpaceInfo : DISK_SPACE_INFORMATION* out -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "KERNEL32.dll" #cfunc global GetDiskSpaceInformationW "GetDiskSpaceInformationW" wstr, sptr ; res = GetDiskSpaceInformationW(rootPath, varptr(diskSpaceInfo)) ; rootPath : LPCWSTR optional -> "wstr" ; diskSpaceInfo : DISK_SPACE_INFORMATION* out -> "sptr" ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
出力引数:
; HRESULT GetDiskSpaceInformationW(LPCWSTR rootPath, DISK_SPACE_INFORMATION* diskSpaceInfo) #uselib "KERNEL32.dll" #cfunc global GetDiskSpaceInformationW "GetDiskSpaceInformationW" wstr, var ; res = GetDiskSpaceInformationW(rootPath, diskSpaceInfo) ; rootPath : LPCWSTR optional -> "wstr" ; diskSpaceInfo : DISK_SPACE_INFORMATION* out -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; HRESULT GetDiskSpaceInformationW(LPCWSTR rootPath, DISK_SPACE_INFORMATION* diskSpaceInfo) #uselib "KERNEL32.dll" #cfunc global GetDiskSpaceInformationW "GetDiskSpaceInformationW" wstr, intptr ; res = GetDiskSpaceInformationW(rootPath, varptr(diskSpaceInfo)) ; rootPath : LPCWSTR optional -> "wstr" ; diskSpaceInfo : DISK_SPACE_INFORMATION* out -> "intptr" ; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。
import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
procGetDiskSpaceInformationW = kernel32.NewProc("GetDiskSpaceInformationW")
)
// rootPath (LPCWSTR optional), diskSpaceInfo (DISK_SPACE_INFORMATION* out)
r1, _, err := procGetDiskSpaceInformationW.Call(
uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(rootPath))),
uintptr(diskSpaceInfo),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // HRESULTfunction GetDiskSpaceInformationW(
rootPath: PWideChar; // LPCWSTR optional
diskSpaceInfo: Pointer // DISK_SPACE_INFORMATION* out
): Integer; stdcall;
external 'KERNEL32.dll' name 'GetDiskSpaceInformationW';result := DllCall("KERNEL32\GetDiskSpaceInformationW"
, "WStr", rootPath ; LPCWSTR optional
, "Ptr", diskSpaceInfo ; DISK_SPACE_INFORMATION* out
, "Int") ; return: HRESULT●GetDiskSpaceInformationW(rootPath, diskSpaceInfo) = DLL("KERNEL32.dll", "int GetDiskSpaceInformationW(char*, void*)")
# 呼び出し: GetDiskSpaceInformationW(rootPath, diskSpaceInfo)
# rootPath : LPCWSTR optional -> "char*"
# diskSpaceInfo : DISK_SPACE_INFORMATION* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。const std = @import("std");
extern "kernel32" fn GetDiskSpaceInformationW(
rootPath: [*c]const u16, // LPCWSTR optional
diskSpaceInfo: [*c]DISK_SPACE_INFORMATION // DISK_SPACE_INFORMATION* out
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。proc GetDiskSpaceInformationW(
rootPath: WideCString, # LPCWSTR optional
diskSpaceInfo: ptr DISK_SPACE_INFORMATION # DISK_SPACE_INFORMATION* out
): int32 {.importc: "GetDiskSpaceInformationW", stdcall, dynlib: "KERNEL32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。pragma(lib, "kernel32");
extern(Windows)
int GetDiskSpaceInformationW(
const(wchar)* rootPath, // LPCWSTR optional
DISK_SPACE_INFORMATION* diskSpaceInfo // DISK_SPACE_INFORMATION* out
);ccall((:GetDiskSpaceInformationW, "KERNEL32.dll"), stdcall, Int32,
(Cwstring, Ptr{DISK_SPACE_INFORMATION}),
rootPath, diskSpaceInfo)
# rootPath : LPCWSTR optional -> Cwstring
# diskSpaceInfo : DISK_SPACE_INFORMATION* out -> Ptr{DISK_SPACE_INFORMATION}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。local ffi = require("ffi")
ffi.cdef[[
int32_t GetDiskSpaceInformationW(
const uint16_t* rootPath,
void* diskSpaceInfo);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.GetDiskSpaceInformationW(rootPath, diskSpaceInfo)
-- rootPath : LPCWSTR optional
-- diskSpaceInfo : DISK_SPACE_INFORMATION* 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('KERNEL32.dll');
const GetDiskSpaceInformationW = lib.func('__stdcall', 'GetDiskSpaceInformationW', 'int32_t', ['str16', 'void *']);
// GetDiskSpaceInformationW(rootPath, diskSpaceInfo)
// rootPath : LPCWSTR optional -> 'str16'
// diskSpaceInfo : DISK_SPACE_INFORMATION* out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("KERNEL32.dll", {
GetDiskSpaceInformationW: { parameters: ["buffer", "pointer"], result: "i32" },
});
// lib.symbols.GetDiskSpaceInformationW(rootPath, diskSpaceInfo)
// rootPath : LPCWSTR optional -> "buffer"
// diskSpaceInfo : DISK_SPACE_INFORMATION* out -> "pointer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t GetDiskSpaceInformationW(
const uint16_t* rootPath,
void* diskSpaceInfo);
C, "KERNEL32.dll");
// $ffi->GetDiskSpaceInformationW(rootPath, diskSpaceInfo);
// rootPath : LPCWSTR 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.UNICODE_OPTIONS);
int GetDiskSpaceInformationW(
WString rootPath, // LPCWSTR optional
Pointer diskSpaceInfo // DISK_SPACE_INFORMATION* out
);
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。@[Link("kernel32")]
lib LibKERNEL32
fun GetDiskSpaceInformationW = GetDiskSpaceInformationW(
rootPath : UInt16*, # LPCWSTR 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 GetDiskSpaceInformationWNative = Int32 Function(Pointer<Utf16>, Pointer<Void>);
typedef GetDiskSpaceInformationWDart = int Function(Pointer<Utf16>, Pointer<Void>);
final GetDiskSpaceInformationW = DynamicLibrary.open('KERNEL32.dll')
.lookupFunction<GetDiskSpaceInformationWNative, GetDiskSpaceInformationWDart>('GetDiskSpaceInformationW');
// rootPath : LPCWSTR optional -> Pointer<Utf16>
// diskSpaceInfo : DISK_SPACE_INFORMATION* out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function GetDiskSpaceInformationW(
rootPath: PWideChar; // LPCWSTR optional
diskSpaceInfo: Pointer // DISK_SPACE_INFORMATION* out
): Integer; stdcall;
external 'KERNEL32.dll' name 'GetDiskSpaceInformationW';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "GetDiskSpaceInformationW"
c_GetDiskSpaceInformationW :: CWString -> Ptr () -> IO Int32
-- rootPath : LPCWSTR optional -> CWString
-- diskSpaceInfo : DISK_SPACE_INFORMATION* out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let getdiskspaceinformationw =
foreign "GetDiskSpaceInformationW"
((ptr uint16_t) @-> (ptr void) @-> returning int32_t)
(* rootPath : LPCWSTR optional -> (ptr uint16_t) *)
(* 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 ("GetDiskSpaceInformationW" get-disk-space-information-w :convention :stdcall) :int32
(root-path (:string :encoding :utf-16le)) ; LPCWSTR 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 $GetDiskSpaceInformationW = Win32::API::More->new('KERNEL32',
'int GetDiskSpaceInformationW(LPCWSTR rootPath, LPVOID diskSpaceInfo)');
# my $ret = $GetDiskSpaceInformationW->Call($rootPath, $diskSpaceInfo);
# rootPath : LPCWSTR optional -> LPCWSTR
# diskSpaceInfo : DISK_SPACE_INFORMATION* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。関連項目
文字セット違い
- f GetDiskSpaceInformationA (ANSI版) — ボリュームの詳細なディスク領域情報を取得する(ANSI版)。