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

SetupRemoveFromDiskSpaceListA

関数
指定ファイルの操作をディスク容量リストから削除する。
DLLSETUPAPI.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり対応OSWindows XP 以降
📘 Microsoft Learn (日本語) · English

シグネチャ

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

BOOL SetupRemoveFromDiskSpaceListA(
    void* DiskSpace,
    LPCSTR TargetFilespec,
    SETUP_FILE_OPERATION Operation,
    void* Reserved1,   // optional
    DWORD Reserved2   // optional
);

パラメーター

名前型方向説明
DiskSpacevoid*in操作を除去するディスク領域リストのハンドル。
TargetFilespecLPCSTRinリストから除去する対象ファイルの完全パス(ANSI)。
OperationSETUP_FILE_OPERATIONin除去対象の操作種別を示すSETUP_FILE_OPERATION値。
Reserved1void*optional予約済み。NULLを指定する必要がある。
Reserved2DWORDoptional予約済み。0を指定する必要がある。

戻り値の型: BOOL

各言語での呼び出し定義

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

BOOL SetupRemoveFromDiskSpaceListA(
    void* DiskSpace,
    LPCSTR TargetFilespec,
    SETUP_FILE_OPERATION Operation,
    void* Reserved1,   // optional
    DWORD Reserved2   // optional
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SETUPAPI.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool SetupRemoveFromDiskSpaceListA(
    IntPtr DiskSpace,   // void*
    [MarshalAs(UnmanagedType.LPStr)] string TargetFilespec,   // LPCSTR
    uint Operation,   // SETUP_FILE_OPERATION
    IntPtr Reserved1,   // void* optional
    uint Reserved2   // DWORD optional
);
<DllImport("SETUPAPI.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SetupRemoveFromDiskSpaceListA(
    DiskSpace As IntPtr,   ' void*
    <MarshalAs(UnmanagedType.LPStr)> TargetFilespec As String,   ' LPCSTR
    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 : LPCSTR
' Operation : SETUP_FILE_OPERATION
' Reserved1 : void* optional
' Reserved2 : DWORD optional
Declare PtrSafe Function SetupRemoveFromDiskSpaceListA Lib "setupapi" ( _
    ByVal DiskSpace As LongPtr, _
    ByVal TargetFilespec As String, _
    ByVal Operation As Long, _
    ByVal Reserved1 As LongPtr, _
    ByVal Reserved2 As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SetupRemoveFromDiskSpaceListA = ctypes.windll.setupapi.SetupRemoveFromDiskSpaceListA
SetupRemoveFromDiskSpaceListA.restype = wintypes.BOOL
SetupRemoveFromDiskSpaceListA.argtypes = [
    ctypes.POINTER(None),  # DiskSpace : void*
    wintypes.LPCSTR,  # TargetFilespec : LPCSTR
    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')
SetupRemoveFromDiskSpaceListA = Fiddle::Function.new(
  lib['SetupRemoveFromDiskSpaceListA'],
  [
    Fiddle::TYPE_VOIDP,  # DiskSpace : void*
    Fiddle::TYPE_VOIDP,  # TargetFilespec : LPCSTR
    -Fiddle::TYPE_INT,  # Operation : SETUP_FILE_OPERATION
    Fiddle::TYPE_VOIDP,  # Reserved1 : void* optional
    -Fiddle::TYPE_INT,  # Reserved2 : DWORD optional
  ],
  Fiddle::TYPE_INT)
#[link(name = "setupapi")]
extern "system" {
    fn SetupRemoveFromDiskSpaceListA(
        DiskSpace: *mut (),  // void*
        TargetFilespec: *const u8,  // LPCSTR
        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.Ansi, SetLastError = true)]
public static extern bool SetupRemoveFromDiskSpaceListA(IntPtr DiskSpace, [MarshalAs(UnmanagedType.LPStr)] string TargetFilespec, uint Operation, IntPtr Reserved1, uint Reserved2);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SETUPAPI_SetupRemoveFromDiskSpaceListA' -Namespace Win32 -PassThru
# $api::SetupRemoveFromDiskSpaceListA(DiskSpace, TargetFilespec, Operation, Reserved1, Reserved2)
#uselib "SETUPAPI.dll"
#func global SetupRemoveFromDiskSpaceListA "SetupRemoveFromDiskSpaceListA" sptr, sptr, sptr, sptr, sptr
; SetupRemoveFromDiskSpaceListA DiskSpace, TargetFilespec, Operation, Reserved1, Reserved2   ; 戻り値は stat
; DiskSpace : void* -> "sptr"
; TargetFilespec : LPCSTR -> "sptr"
; Operation : SETUP_FILE_OPERATION -> "sptr"
; Reserved1 : void* optional -> "sptr"
; Reserved2 : DWORD optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "SETUPAPI.dll"
#cfunc global SetupRemoveFromDiskSpaceListA "SetupRemoveFromDiskSpaceListA" sptr, str, int, sptr, int
; res = SetupRemoveFromDiskSpaceListA(DiskSpace, TargetFilespec, Operation, Reserved1, Reserved2)
; DiskSpace : void* -> "sptr"
; TargetFilespec : LPCSTR -> "str"
; Operation : SETUP_FILE_OPERATION -> "int"
; Reserved1 : void* optional -> "sptr"
; Reserved2 : DWORD optional -> "int"
; BOOL SetupRemoveFromDiskSpaceListA(void* DiskSpace, LPCSTR TargetFilespec, SETUP_FILE_OPERATION Operation, void* Reserved1, DWORD Reserved2)
#uselib "SETUPAPI.dll"
#cfunc global SetupRemoveFromDiskSpaceListA "SetupRemoveFromDiskSpaceListA" intptr, str, int, intptr, int
; res = SetupRemoveFromDiskSpaceListA(DiskSpace, TargetFilespec, Operation, Reserved1, Reserved2)
; DiskSpace : void* -> "intptr"
; TargetFilespec : LPCSTR -> "str"
; 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")
	procSetupRemoveFromDiskSpaceListA = setupapi.NewProc("SetupRemoveFromDiskSpaceListA")
)

// DiskSpace (void*), TargetFilespec (LPCSTR), Operation (SETUP_FILE_OPERATION), Reserved1 (void* optional), Reserved2 (DWORD optional)
r1, _, err := procSetupRemoveFromDiskSpaceListA.Call(
	uintptr(DiskSpace),
	uintptr(unsafe.Pointer(windows.BytePtrFromString(TargetFilespec))),
	uintptr(Operation),
	uintptr(Reserved1),
	uintptr(Reserved2),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function SetupRemoveFromDiskSpaceListA(
  DiskSpace: Pointer;   // void*
  TargetFilespec: PAnsiChar;   // LPCSTR
  Operation: DWORD;   // SETUP_FILE_OPERATION
  Reserved1: Pointer;   // void* optional
  Reserved2: DWORD   // DWORD optional
): BOOL; stdcall;
  external 'SETUPAPI.dll' name 'SetupRemoveFromDiskSpaceListA';
result := DllCall("SETUPAPI\SetupRemoveFromDiskSpaceListA"
    , "Ptr", DiskSpace   ; void*
    , "AStr", TargetFilespec   ; LPCSTR
    , "UInt", Operation   ; SETUP_FILE_OPERATION
    , "Ptr", Reserved1   ; void* optional
    , "UInt", Reserved2   ; DWORD optional
    , "Int")   ; return: BOOL
●SetupRemoveFromDiskSpaceListA(DiskSpace, TargetFilespec, Operation, Reserved1, Reserved2) = DLL("SETUPAPI.dll", "bool SetupRemoveFromDiskSpaceListA(void*, char*, dword, void*, dword)")
# 呼び出し: SetupRemoveFromDiskSpaceListA(DiskSpace, TargetFilespec, Operation, Reserved1, Reserved2)
# DiskSpace : void* -> "void*"
# TargetFilespec : LPCSTR -> "char*"
# Operation : SETUP_FILE_OPERATION -> "dword"
# Reserved1 : void* optional -> "void*"
# Reserved2 : DWORD optional -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "setupapi" fn SetupRemoveFromDiskSpaceListA(
    DiskSpace: ?*anyopaque, // void*
    TargetFilespec: [*c]const u8, // LPCSTR
    Operation: u32, // SETUP_FILE_OPERATION
    Reserved1: ?*anyopaque, // void* optional
    Reserved2: u32 // DWORD optional
) callconv(std.os.windows.WINAPI) i32;
proc SetupRemoveFromDiskSpaceListA(
    DiskSpace: pointer,  # void*
    TargetFilespec: cstring,  # LPCSTR
    Operation: uint32,  # SETUP_FILE_OPERATION
    Reserved1: pointer,  # void* optional
    Reserved2: uint32  # DWORD optional
): int32 {.importc: "SetupRemoveFromDiskSpaceListA", stdcall, dynlib: "SETUPAPI.dll".}
pragma(lib, "setupapi");
extern(Windows)
int SetupRemoveFromDiskSpaceListA(
    void* DiskSpace,   // void*
    const(char)* TargetFilespec,   // LPCSTR
    uint Operation,   // SETUP_FILE_OPERATION
    void* Reserved1,   // void* optional
    uint Reserved2   // DWORD optional
);
ccall((:SetupRemoveFromDiskSpaceListA, "SETUPAPI.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Cstring, UInt32, Ptr{Cvoid}, UInt32),
      DiskSpace, TargetFilespec, Operation, Reserved1, Reserved2)
# DiskSpace : void* -> Ptr{Cvoid}
# TargetFilespec : LPCSTR -> Cstring
# Operation : SETUP_FILE_OPERATION -> UInt32
# Reserved1 : void* optional -> Ptr{Cvoid}
# Reserved2 : DWORD optional -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t SetupRemoveFromDiskSpaceListA(
    void* DiskSpace,
    const char* TargetFilespec,
    uint32_t Operation,
    void* Reserved1,
    uint32_t Reserved2);
]]
local setupapi = ffi.load("setupapi")
-- setupapi.SetupRemoveFromDiskSpaceListA(DiskSpace, TargetFilespec, Operation, Reserved1, Reserved2)
-- DiskSpace : void*
-- TargetFilespec : LPCSTR
-- Operation : SETUP_FILE_OPERATION
-- Reserved1 : void* optional
-- Reserved2 : DWORD optional
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('SETUPAPI.dll');
const SetupRemoveFromDiskSpaceListA = lib.func('__stdcall', 'SetupRemoveFromDiskSpaceListA', 'int32_t', ['void *', 'str', 'uint32_t', 'void *', 'uint32_t']);
// SetupRemoveFromDiskSpaceListA(DiskSpace, TargetFilespec, Operation, Reserved1, Reserved2)
// DiskSpace : void* -> 'void *'
// TargetFilespec : LPCSTR -> 'str'
// 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", {
  SetupRemoveFromDiskSpaceListA: { parameters: ["pointer", "buffer", "u32", "pointer", "u32"], result: "i32" },
});
// lib.symbols.SetupRemoveFromDiskSpaceListA(DiskSpace, TargetFilespec, Operation, Reserved1, Reserved2)
// DiskSpace : void* -> "pointer"
// TargetFilespec : LPCSTR -> "buffer"
// Operation : SETUP_FILE_OPERATION -> "u32"
// Reserved1 : void* optional -> "pointer"
// Reserved2 : DWORD optional -> "u32"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t SetupRemoveFromDiskSpaceListA(
    void* DiskSpace,
    const char* TargetFilespec,
    uint32_t Operation,
    void* Reserved1,
    uint32_t Reserved2);
C, "SETUPAPI.dll");
// $ffi->SetupRemoveFromDiskSpaceListA(DiskSpace, TargetFilespec, Operation, Reserved1, Reserved2);
// DiskSpace : void*
// TargetFilespec : LPCSTR
// 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.ASCII_OPTIONS);
    boolean SetupRemoveFromDiskSpaceListA(
        Pointer DiskSpace,   // void*
        String TargetFilespec,   // LPCSTR
        int Operation,   // SETUP_FILE_OPERATION
        Pointer Reserved1,   // void* optional
        int Reserved2   // DWORD optional
    );
}
@[Link("setupapi")]
lib LibSETUPAPI
  fun SetupRemoveFromDiskSpaceListA = SetupRemoveFromDiskSpaceListA(
    DiskSpace : Void*,   # void*
    TargetFilespec : UInt8*,   # LPCSTR
    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 SetupRemoveFromDiskSpaceListANative = Int32 Function(Pointer<Void>, Pointer<Utf8>, Uint32, Pointer<Void>, Uint32);
typedef SetupRemoveFromDiskSpaceListADart = int Function(Pointer<Void>, Pointer<Utf8>, int, Pointer<Void>, int);
final SetupRemoveFromDiskSpaceListA = DynamicLibrary.open('SETUPAPI.dll')
    .lookupFunction<SetupRemoveFromDiskSpaceListANative, SetupRemoveFromDiskSpaceListADart>('SetupRemoveFromDiskSpaceListA');
// DiskSpace : void* -> Pointer<Void>
// TargetFilespec : LPCSTR -> Pointer<Utf8>
// Operation : SETUP_FILE_OPERATION -> Uint32
// Reserved1 : void* optional -> Pointer<Void>
// Reserved2 : DWORD optional -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SetupRemoveFromDiskSpaceListA(
  DiskSpace: Pointer;   // void*
  TargetFilespec: PAnsiChar;   // LPCSTR
  Operation: DWORD;   // SETUP_FILE_OPERATION
  Reserved1: Pointer;   // void* optional
  Reserved2: DWORD   // DWORD optional
): BOOL; stdcall;
  external 'SETUPAPI.dll' name 'SetupRemoveFromDiskSpaceListA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SetupRemoveFromDiskSpaceListA"
  c_SetupRemoveFromDiskSpaceListA :: Ptr () -> CString -> Word32 -> Ptr () -> Word32 -> IO CInt
-- DiskSpace : void* -> Ptr ()
-- TargetFilespec : LPCSTR -> CString
-- 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 setupremovefromdiskspacelista =
  foreign "SetupRemoveFromDiskSpaceListA"
    ((ptr void) @-> string @-> uint32_t @-> (ptr void) @-> uint32_t @-> returning int32_t)
(* DiskSpace : void* -> (ptr void) *)
(* TargetFilespec : LPCSTR -> string *)
(* 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 ("SetupRemoveFromDiskSpaceListA" setup-remove-from-disk-space-list-a :convention :stdcall) :int32
  (disk-space :pointer)   ; void*
  (target-filespec :string)   ; LPCSTR
  (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 $SetupRemoveFromDiskSpaceListA = Win32::API::More->new('SETUPAPI',
    'BOOL SetupRemoveFromDiskSpaceListA(LPVOID DiskSpace, LPCSTR TargetFilespec, DWORD Operation, LPVOID Reserved1, DWORD Reserved2)');
# my $ret = $SetupRemoveFromDiskSpaceListA->Call($DiskSpace, $TargetFilespec, $Operation, $Reserved1, $Reserved2);
# DiskSpace : void* -> LPVOID
# TargetFilespec : LPCSTR -> LPCSTR
# Operation : SETUP_FILE_OPERATION -> DWORD
# Reserved1 : void* optional -> LPVOID
# Reserved2 : DWORD optional -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

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