Win32 API 日本語リファレンス
ホームDevices.DeviceAndDriverInstallation › SetupQueryDrivesInDiskSpaceListW

SetupQueryDrivesInDiskSpaceListW

関数
ディスク空き領域リストに含まれるドライブを照会する(Unicode)。
DLLSETUPAPI.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

BOOL SetupQueryDrivesInDiskSpaceListW(
    void* DiskSpace,
    LPWSTR ReturnBuffer,   // optional
    DWORD ReturnBufferSize,
    DWORD* RequiredSize   // optional
);

パラメーター

名前方向
DiskSpacevoid*in
ReturnBufferLPWSTRoutoptional
ReturnBufferSizeDWORDin
RequiredSizeDWORD*outoptional

戻り値の型: BOOL

各言語での呼び出し定義

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

BOOL SetupQueryDrivesInDiskSpaceListW(
    void* DiskSpace,
    LPWSTR ReturnBuffer,   // optional
    DWORD ReturnBufferSize,
    DWORD* RequiredSize   // optional
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SETUPAPI.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool SetupQueryDrivesInDiskSpaceListW(
    IntPtr DiskSpace,   // void*
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder ReturnBuffer,   // LPWSTR optional, out
    uint ReturnBufferSize,   // DWORD
    IntPtr RequiredSize   // DWORD* optional, out
);
<DllImport("SETUPAPI.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SetupQueryDrivesInDiskSpaceListW(
    DiskSpace As IntPtr,   ' void*
    <MarshalAs(UnmanagedType.LPWStr)> ReturnBuffer As System.Text.StringBuilder,   ' LPWSTR optional, out
    ReturnBufferSize As UInteger,   ' DWORD
    RequiredSize As IntPtr   ' DWORD* optional, out
) As Boolean
End Function
' DiskSpace : void*
' ReturnBuffer : LPWSTR optional, out
' ReturnBufferSize : DWORD
' RequiredSize : DWORD* optional, out
Declare PtrSafe Function SetupQueryDrivesInDiskSpaceListW Lib "setupapi" ( _
    ByVal DiskSpace As LongPtr, _
    ByVal ReturnBuffer As LongPtr, _
    ByVal ReturnBufferSize As Long, _
    ByVal RequiredSize 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

SetupQueryDrivesInDiskSpaceListW = ctypes.windll.setupapi.SetupQueryDrivesInDiskSpaceListW
SetupQueryDrivesInDiskSpaceListW.restype = wintypes.BOOL
SetupQueryDrivesInDiskSpaceListW.argtypes = [
    ctypes.POINTER(None),  # DiskSpace : void*
    wintypes.LPWSTR,  # ReturnBuffer : LPWSTR optional, out
    wintypes.DWORD,  # ReturnBufferSize : DWORD
    ctypes.POINTER(wintypes.DWORD),  # RequiredSize : DWORD* optional, out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SETUPAPI.dll')
SetupQueryDrivesInDiskSpaceListW = Fiddle::Function.new(
  lib['SetupQueryDrivesInDiskSpaceListW'],
  [
    Fiddle::TYPE_VOIDP,  # DiskSpace : void*
    Fiddle::TYPE_VOIDP,  # ReturnBuffer : LPWSTR optional, out
    -Fiddle::TYPE_INT,  # ReturnBufferSize : DWORD
    Fiddle::TYPE_VOIDP,  # RequiredSize : DWORD* optional, out
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "setupapi")]
extern "system" {
    fn SetupQueryDrivesInDiskSpaceListW(
        DiskSpace: *mut (),  // void*
        ReturnBuffer: *mut u16,  // LPWSTR optional, out
        ReturnBufferSize: u32,  // DWORD
        RequiredSize: *mut u32  // DWORD* optional, out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SETUPAPI.dll", CharSet = CharSet.Unicode, SetLastError = true)]
public static extern bool SetupQueryDrivesInDiskSpaceListW(IntPtr DiskSpace, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder ReturnBuffer, uint ReturnBufferSize, IntPtr RequiredSize);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SETUPAPI_SetupQueryDrivesInDiskSpaceListW' -Namespace Win32 -PassThru
# $api::SetupQueryDrivesInDiskSpaceListW(DiskSpace, ReturnBuffer, ReturnBufferSize, RequiredSize)
#uselib "SETUPAPI.dll"
#func global SetupQueryDrivesInDiskSpaceListW "SetupQueryDrivesInDiskSpaceListW" wptr, wptr, wptr, wptr
; SetupQueryDrivesInDiskSpaceListW DiskSpace, varptr(ReturnBuffer), ReturnBufferSize, varptr(RequiredSize)   ; 戻り値は stat
; DiskSpace : void* -> "wptr"
; ReturnBuffer : LPWSTR optional, out -> "wptr"
; ReturnBufferSize : DWORD -> "wptr"
; RequiredSize : DWORD* optional, out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "SETUPAPI.dll"
#cfunc global SetupQueryDrivesInDiskSpaceListW "SetupQueryDrivesInDiskSpaceListW" sptr, var, int, var
; res = SetupQueryDrivesInDiskSpaceListW(DiskSpace, ReturnBuffer, ReturnBufferSize, RequiredSize)
; DiskSpace : void* -> "sptr"
; ReturnBuffer : LPWSTR optional, out -> "var"
; ReturnBufferSize : DWORD -> "int"
; RequiredSize : DWORD* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL SetupQueryDrivesInDiskSpaceListW(void* DiskSpace, LPWSTR ReturnBuffer, DWORD ReturnBufferSize, DWORD* RequiredSize)
#uselib "SETUPAPI.dll"
#cfunc global SetupQueryDrivesInDiskSpaceListW "SetupQueryDrivesInDiskSpaceListW" intptr, var, int, var
; res = SetupQueryDrivesInDiskSpaceListW(DiskSpace, ReturnBuffer, ReturnBufferSize, RequiredSize)
; DiskSpace : void* -> "intptr"
; ReturnBuffer : LPWSTR optional, out -> "var"
; ReturnBufferSize : DWORD -> "int"
; RequiredSize : DWORD* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	setupapi = windows.NewLazySystemDLL("SETUPAPI.dll")
	procSetupQueryDrivesInDiskSpaceListW = setupapi.NewProc("SetupQueryDrivesInDiskSpaceListW")
)

// DiskSpace (void*), ReturnBuffer (LPWSTR optional, out), ReturnBufferSize (DWORD), RequiredSize (DWORD* optional, out)
r1, _, err := procSetupQueryDrivesInDiskSpaceListW.Call(
	uintptr(DiskSpace),
	uintptr(ReturnBuffer),
	uintptr(ReturnBufferSize),
	uintptr(RequiredSize),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function SetupQueryDrivesInDiskSpaceListW(
  DiskSpace: Pointer;   // void*
  ReturnBuffer: PWideChar;   // LPWSTR optional, out
  ReturnBufferSize: DWORD;   // DWORD
  RequiredSize: Pointer   // DWORD* optional, out
): BOOL; stdcall;
  external 'SETUPAPI.dll' name 'SetupQueryDrivesInDiskSpaceListW';
result := DllCall("SETUPAPI\SetupQueryDrivesInDiskSpaceListW"
    , "Ptr", DiskSpace   ; void*
    , "Ptr", ReturnBuffer   ; LPWSTR optional, out
    , "UInt", ReturnBufferSize   ; DWORD
    , "Ptr", RequiredSize   ; DWORD* optional, out
    , "Int")   ; return: BOOL
●SetupQueryDrivesInDiskSpaceListW(DiskSpace, ReturnBuffer, ReturnBufferSize, RequiredSize) = DLL("SETUPAPI.dll", "bool SetupQueryDrivesInDiskSpaceListW(void*, char*, dword, void*)")
# 呼び出し: SetupQueryDrivesInDiskSpaceListW(DiskSpace, ReturnBuffer, ReturnBufferSize, RequiredSize)
# DiskSpace : void* -> "void*"
# ReturnBuffer : LPWSTR optional, out -> "char*"
# ReturnBufferSize : DWORD -> "dword"
# RequiredSize : DWORD* optional, out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。