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

SetupAddToDiskSpaceListW

関数
指定ファイルの操作をディスク容量リストに追加し所要量を計上する。
DLLSETUPAPI.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows XP 以降
📘 Microsoft Learn (日本語) · English

シグネチャ

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

BOOL SetupAddToDiskSpaceListW(
    void* DiskSpace,
    LPCWSTR TargetFilespec,
    LONGLONG FileSize,
    SETUP_FILE_OPERATION Operation,
    void* Reserved1,   // optional
    DWORD Reserved2   // optional
);

パラメーター

名前型方向説明
DiskSpacevoid*in操作を追加するディスク領域リストのハンドル。
TargetFilespecLPCWSTRin対象ファイルの完全パス(Unicode)。
FileSizeLONGLONGin対象ファイルのサイズをバイト単位で指定する。
OperationSETUP_FILE_OPERATIONinコピーか削除かを示すSETUP_FILE_OPERATION値。
Reserved1void*optional予約済み。NULLを指定する必要がある。
Reserved2DWORDoptional予約済み。0を指定する必要がある。

戻り値の型: BOOL

各言語での呼び出し定義

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

BOOL SetupAddToDiskSpaceListW(
    void* DiskSpace,
    LPCWSTR TargetFilespec,
    LONGLONG FileSize,
    SETUP_FILE_OPERATION Operation,
    void* Reserved1,   // optional
    DWORD Reserved2   // optional
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SETUPAPI.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool SetupAddToDiskSpaceListW(
    IntPtr DiskSpace,   // void*
    [MarshalAs(UnmanagedType.LPWStr)] string TargetFilespec,   // LPCWSTR
    long FileSize,   // LONGLONG
    uint Operation,   // SETUP_FILE_OPERATION
    IntPtr Reserved1,   // void* optional
    uint Reserved2   // DWORD optional
);
<DllImport("SETUPAPI.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SetupAddToDiskSpaceListW(
    DiskSpace As IntPtr,   ' void*
    <MarshalAs(UnmanagedType.LPWStr)> TargetFilespec As String,   ' LPCWSTR
    FileSize As Long,   ' LONGLONG
    Operation As UInteger,   ' SETUP_FILE_OPERATION
    Reserved1 As IntPtr,   ' void* optional
    Reserved2 As UInteger   ' DWORD optional
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' DiskSpace : void*
' TargetFilespec : LPCWSTR
' FileSize : LONGLONG
' Operation : SETUP_FILE_OPERATION
' Reserved1 : void* optional
' Reserved2 : DWORD optional
Declare PtrSafe Function SetupAddToDiskSpaceListW Lib "setupapi" ( _
    ByVal DiskSpace As LongPtr, _
    ByVal TargetFilespec As LongPtr, _
    ByVal FileSize As LongLong, _
    ByVal Operation As Long, _
    ByVal Reserved1 As LongPtr, _
    ByVal Reserved2 As Long) 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

SetupAddToDiskSpaceListW = ctypes.windll.setupapi.SetupAddToDiskSpaceListW
SetupAddToDiskSpaceListW.restype = wintypes.BOOL
SetupAddToDiskSpaceListW.argtypes = [
    ctypes.POINTER(None),  # DiskSpace : void*
    wintypes.LPCWSTR,  # TargetFilespec : LPCWSTR
    ctypes.c_longlong,  # FileSize : LONGLONG
    wintypes.DWORD,  # Operation : SETUP_FILE_OPERATION
    ctypes.POINTER(None),  # Reserved1 : void* optional
    wintypes.DWORD,  # Reserved2 : DWORD optional
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SETUPAPI.dll')
SetupAddToDiskSpaceListW = Fiddle::Function.new(
  lib['SetupAddToDiskSpaceListW'],
  [
    Fiddle::TYPE_VOIDP,  # DiskSpace : void*
    Fiddle::TYPE_VOIDP,  # TargetFilespec : LPCWSTR
    Fiddle::TYPE_LONG_LONG,  # FileSize : LONGLONG
    -Fiddle::TYPE_INT,  # Operation : SETUP_FILE_OPERATION
    Fiddle::TYPE_VOIDP,  # Reserved1 : void* optional
    -Fiddle::TYPE_INT,  # Reserved2 : DWORD optional
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "setupapi")]
extern "system" {
    fn SetupAddToDiskSpaceListW(
        DiskSpace: *mut (),  // void*
        TargetFilespec: *const u16,  // LPCWSTR
        FileSize: i64,  // LONGLONG
        Operation: u32,  // SETUP_FILE_OPERATION
        Reserved1: *mut (),  // void* optional
        Reserved2: u32  // DWORD optional
    ) -> 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 SetupAddToDiskSpaceListW(IntPtr DiskSpace, [MarshalAs(UnmanagedType.LPWStr)] string TargetFilespec, long FileSize, uint Operation, IntPtr Reserved1, uint Reserved2);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SETUPAPI_SetupAddToDiskSpaceListW' -Namespace Win32 -PassThru
# $api::SetupAddToDiskSpaceListW(DiskSpace, TargetFilespec, FileSize, Operation, Reserved1, Reserved2)
#uselib "SETUPAPI.dll"
#func global SetupAddToDiskSpaceListW "SetupAddToDiskSpaceListW" wptr, wptr, wptr, wptr, wptr, wptr
; SetupAddToDiskSpaceListW DiskSpace, TargetFilespec, FileSize, Operation, Reserved1, Reserved2   ; 戻り値は stat
; DiskSpace : void* -> "wptr"
; TargetFilespec : LPCWSTR -> "wptr"
; FileSize : LONGLONG -> "wptr"
; Operation : SETUP_FILE_OPERATION -> "wptr"
; Reserved1 : void* optional -> "wptr"
; Reserved2 : DWORD optional -> "wptr"
; ※HSP3.7は int64 引数(64bit値渡し)に非対応です。
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "SETUPAPI.dll"
#cfunc global SetupAddToDiskSpaceListW "SetupAddToDiskSpaceListW" sptr, wstr, int64, int, sptr, int
; res = SetupAddToDiskSpaceListW(DiskSpace, TargetFilespec, FileSize, Operation, Reserved1, Reserved2)
; DiskSpace : void* -> "sptr"
; TargetFilespec : LPCWSTR -> "wstr"
; FileSize : LONGLONG -> "int64"
; Operation : SETUP_FILE_OPERATION -> "int"
; Reserved1 : void* optional -> "sptr"
; Reserved2 : DWORD optional -> "int"
; ※int64 引数の DLL 値渡しは x64 ランタイム(hsp3_64)のみ対応(x86 は未対応)。
; BOOL SetupAddToDiskSpaceListW(void* DiskSpace, LPCWSTR TargetFilespec, LONGLONG FileSize, SETUP_FILE_OPERATION Operation, void* Reserved1, DWORD Reserved2)
#uselib "SETUPAPI.dll"
#cfunc global SetupAddToDiskSpaceListW "SetupAddToDiskSpaceListW" intptr, wstr, int64, int, intptr, int
; res = SetupAddToDiskSpaceListW(DiskSpace, TargetFilespec, FileSize, Operation, Reserved1, Reserved2)
; DiskSpace : void* -> "intptr"
; TargetFilespec : LPCWSTR -> "wstr"
; FileSize : LONGLONG -> "int64"
; Operation : SETUP_FILE_OPERATION -> "int"
; Reserved1 : void* optional -> "intptr"
; Reserved2 : DWORD optional -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	setupapi = windows.NewLazySystemDLL("SETUPAPI.dll")
	procSetupAddToDiskSpaceListW = setupapi.NewProc("SetupAddToDiskSpaceListW")
)

// DiskSpace (void*), TargetFilespec (LPCWSTR), FileSize (LONGLONG), Operation (SETUP_FILE_OPERATION), Reserved1 (void* optional), Reserved2 (DWORD optional)
r1, _, err := procSetupAddToDiskSpaceListW.Call(
	uintptr(DiskSpace),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(TargetFilespec))),
	uintptr(FileSize),
	uintptr(Operation),
	uintptr(Reserved1),
	uintptr(Reserved2),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function SetupAddToDiskSpaceListW(
  DiskSpace: Pointer;   // void*
  TargetFilespec: PWideChar;   // LPCWSTR
  FileSize: Int64;   // LONGLONG
  Operation: DWORD;   // SETUP_FILE_OPERATION
  Reserved1: Pointer;   // void* optional
  Reserved2: DWORD   // DWORD optional
): BOOL; stdcall;
  external 'SETUPAPI.dll' name 'SetupAddToDiskSpaceListW';
result := DllCall("SETUPAPI\SetupAddToDiskSpaceListW"
    , "Ptr", DiskSpace   ; void*
    , "WStr", TargetFilespec   ; LPCWSTR
    , "Int64", FileSize   ; LONGLONG
    , "UInt", Operation   ; SETUP_FILE_OPERATION
    , "Ptr", Reserved1   ; void* optional
    , "UInt", Reserved2   ; DWORD optional
    , "Int")   ; return: BOOL
●SetupAddToDiskSpaceListW(DiskSpace, TargetFilespec, FileSize, Operation, Reserved1, Reserved2) = DLL("SETUPAPI.dll", "bool SetupAddToDiskSpaceListW(void*, char*, int64, dword, void*, dword)")
# 呼び出し: SetupAddToDiskSpaceListW(DiskSpace, TargetFilespec, FileSize, Operation, Reserved1, Reserved2)
# DiskSpace : void* -> "void*"
# TargetFilespec : LPCWSTR -> "char*"
# FileSize : LONGLONG -> "int64"
# Operation : SETUP_FILE_OPERATION -> "dword"
# Reserved1 : void* optional -> "void*"
# Reserved2 : DWORD optional -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "setupapi" fn SetupAddToDiskSpaceListW(
    DiskSpace: ?*anyopaque, // void*
    TargetFilespec: [*c]const u16, // LPCWSTR
    FileSize: i64, // LONGLONG
    Operation: u32, // SETUP_FILE_OPERATION
    Reserved1: ?*anyopaque, // void* optional
    Reserved2: u32 // DWORD optional
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc SetupAddToDiskSpaceListW(
    DiskSpace: pointer,  # void*
    TargetFilespec: WideCString,  # LPCWSTR
    FileSize: int64,  # LONGLONG
    Operation: uint32,  # SETUP_FILE_OPERATION
    Reserved1: pointer,  # void* optional
    Reserved2: uint32  # DWORD optional
): int32 {.importc: "SetupAddToDiskSpaceListW", stdcall, dynlib: "SETUPAPI.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "setupapi");
extern(Windows)
int SetupAddToDiskSpaceListW(
    void* DiskSpace,   // void*
    const(wchar)* TargetFilespec,   // LPCWSTR
    long FileSize,   // LONGLONG
    uint Operation,   // SETUP_FILE_OPERATION
    void* Reserved1,   // void* optional
    uint Reserved2   // DWORD optional
);
ccall((:SetupAddToDiskSpaceListW, "SETUPAPI.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Cwstring, Int64, UInt32, Ptr{Cvoid}, UInt32),
      DiskSpace, TargetFilespec, FileSize, Operation, Reserved1, Reserved2)
# DiskSpace : void* -> Ptr{Cvoid}
# TargetFilespec : LPCWSTR -> Cwstring
# FileSize : LONGLONG -> Int64
# Operation : SETUP_FILE_OPERATION -> UInt32
# Reserved1 : void* optional -> Ptr{Cvoid}
# Reserved2 : DWORD optional -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
int32_t SetupAddToDiskSpaceListW(
    void* DiskSpace,
    const uint16_t* TargetFilespec,
    int64_t FileSize,
    uint32_t Operation,
    void* Reserved1,
    uint32_t Reserved2);
]]
local setupapi = ffi.load("setupapi")
-- setupapi.SetupAddToDiskSpaceListW(DiskSpace, TargetFilespec, FileSize, Operation, Reserved1, Reserved2)
-- DiskSpace : void*
-- TargetFilespec : LPCWSTR
-- FileSize : LONGLONG
-- Operation : SETUP_FILE_OPERATION
-- Reserved1 : void* optional
-- Reserved2 : DWORD optional
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('SETUPAPI.dll');
const SetupAddToDiskSpaceListW = lib.func('__stdcall', 'SetupAddToDiskSpaceListW', 'int32_t', ['void *', 'str16', 'int64_t', 'uint32_t', 'void *', 'uint32_t']);
// SetupAddToDiskSpaceListW(DiskSpace, TargetFilespec, FileSize, Operation, Reserved1, Reserved2)
// DiskSpace : void* -> 'void *'
// TargetFilespec : LPCWSTR -> 'str16'
// FileSize : LONGLONG -> 'int64_t'
// Operation : SETUP_FILE_OPERATION -> 'uint32_t'
// Reserved1 : void* optional -> 'void *'
// Reserved2 : DWORD optional -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("SETUPAPI.dll", {
  SetupAddToDiskSpaceListW: { parameters: ["pointer", "buffer", "i64", "u32", "pointer", "u32"], result: "i32" },
});
// lib.symbols.SetupAddToDiskSpaceListW(DiskSpace, TargetFilespec, FileSize, Operation, Reserved1, Reserved2)
// DiskSpace : void* -> "pointer"
// TargetFilespec : LPCWSTR -> "buffer"
// FileSize : LONGLONG -> "i64"
// Operation : SETUP_FILE_OPERATION -> "u32"
// Reserved1 : void* optional -> "pointer"
// Reserved2 : DWORD optional -> "u32"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t SetupAddToDiskSpaceListW(
    void* DiskSpace,
    const uint16_t* TargetFilespec,
    int64_t FileSize,
    uint32_t Operation,
    void* Reserved1,
    uint32_t Reserved2);
C, "SETUPAPI.dll");
// $ffi->SetupAddToDiskSpaceListW(DiskSpace, TargetFilespec, FileSize, Operation, Reserved1, Reserved2);
// DiskSpace : void*
// TargetFilespec : LPCWSTR
// FileSize : LONGLONG
// Operation : SETUP_FILE_OPERATION
// Reserved1 : void* optional
// Reserved2 : DWORD optional
// 構造体/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 Setupapi extends StdCallLibrary {
    Setupapi INSTANCE = Native.load("setupapi", Setupapi.class, W32APIOptions.UNICODE_OPTIONS);
    boolean SetupAddToDiskSpaceListW(
        Pointer DiskSpace,   // void*
        WString TargetFilespec,   // LPCWSTR
        long FileSize,   // LONGLONG
        int Operation,   // SETUP_FILE_OPERATION
        Pointer Reserved1,   // void* optional
        int Reserved2   // DWORD optional
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("setupapi")]
lib LibSETUPAPI
  fun SetupAddToDiskSpaceListW = SetupAddToDiskSpaceListW(
    DiskSpace : Void*,   # void*
    TargetFilespec : UInt16*,   # LPCWSTR
    FileSize : Int64,   # LONGLONG
    Operation : UInt32,   # SETUP_FILE_OPERATION
    Reserved1 : Void*,   # void* optional
    Reserved2 : UInt32   # DWORD optional
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef SetupAddToDiskSpaceListWNative = Int32 Function(Pointer<Void>, Pointer<Utf16>, Int64, Uint32, Pointer<Void>, Uint32);
typedef SetupAddToDiskSpaceListWDart = int Function(Pointer<Void>, Pointer<Utf16>, int, int, Pointer<Void>, int);
final SetupAddToDiskSpaceListW = DynamicLibrary.open('SETUPAPI.dll')
    .lookupFunction<SetupAddToDiskSpaceListWNative, SetupAddToDiskSpaceListWDart>('SetupAddToDiskSpaceListW');
// DiskSpace : void* -> Pointer<Void>
// TargetFilespec : LPCWSTR -> Pointer<Utf16>
// FileSize : LONGLONG -> Int64
// Operation : SETUP_FILE_OPERATION -> Uint32
// Reserved1 : void* optional -> Pointer<Void>
// Reserved2 : DWORD optional -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SetupAddToDiskSpaceListW(
  DiskSpace: Pointer;   // void*
  TargetFilespec: PWideChar;   // LPCWSTR
  FileSize: Int64;   // LONGLONG
  Operation: DWORD;   // SETUP_FILE_OPERATION
  Reserved1: Pointer;   // void* optional
  Reserved2: DWORD   // DWORD optional
): BOOL; stdcall;
  external 'SETUPAPI.dll' name 'SetupAddToDiskSpaceListW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SetupAddToDiskSpaceListW"
  c_SetupAddToDiskSpaceListW :: Ptr () -> CWString -> Int64 -> Word32 -> Ptr () -> Word32 -> IO CInt
-- DiskSpace : void* -> Ptr ()
-- TargetFilespec : LPCWSTR -> CWString
-- FileSize : LONGLONG -> Int64
-- Operation : SETUP_FILE_OPERATION -> Word32
-- Reserved1 : void* optional -> Ptr ()
-- Reserved2 : DWORD optional -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let setupaddtodiskspacelistw =
  foreign "SetupAddToDiskSpaceListW"
    ((ptr void) @-> (ptr uint16_t) @-> int64_t @-> uint32_t @-> (ptr void) @-> uint32_t @-> returning int32_t)
(* DiskSpace : void* -> (ptr void) *)
(* TargetFilespec : LPCWSTR -> (ptr uint16_t) *)
(* FileSize : LONGLONG -> int64_t *)
(* Operation : SETUP_FILE_OPERATION -> uint32_t *)
(* Reserved1 : void* optional -> (ptr void) *)
(* Reserved2 : DWORD optional -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library setupapi (t "SETUPAPI.dll"))
(cffi:use-foreign-library setupapi)

(cffi:defcfun ("SetupAddToDiskSpaceListW" setup-add-to-disk-space-list-w :convention :stdcall) :int32
  (disk-space :pointer)   ; void*
  (target-filespec (:string :encoding :utf-16le))   ; LPCWSTR
  (file-size :int64)   ; LONGLONG
  (operation :uint32)   ; SETUP_FILE_OPERATION
  (reserved1 :pointer)   ; void* optional
  (reserved2 :uint32))   ; DWORD optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SetupAddToDiskSpaceListW = Win32::API::More->new('SETUPAPI',
    'BOOL SetupAddToDiskSpaceListW(LPVOID DiskSpace, LPCWSTR TargetFilespec, INT64 FileSize, DWORD Operation, LPVOID Reserved1, DWORD Reserved2)');
# my $ret = $SetupAddToDiskSpaceListW->Call($DiskSpace, $TargetFilespec, $FileSize, $Operation, $Reserved1, $Reserved2);
# DiskSpace : void* -> LPVOID
# TargetFilespec : LPCWSTR -> LPCWSTR
# FileSize : LONGLONG -> INT64
# Operation : SETUP_FILE_OPERATION -> DWORD
# Reserved1 : void* optional -> LPVOID
# Reserved2 : DWORD optional -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

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