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

SetupDecompressOrCopyFileA

関数
ファイルを必要に応じて展開しつつコピーする(ANSI)。
DLLSETUPAPI.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

DWORD SetupDecompressOrCopyFileA(
    LPCSTR SourceFileName,
    LPCSTR TargetFileName,
    FILE_COMPRESSION_TYPE* CompressionType   // optional
);

パラメーター

名前方向説明
SourceFileNameLPCSTRinコピーまたは展開する元ファイル名(ANSI)。
TargetFileNameLPCSTRin出力先のファイル名(ANSI)。
CompressionTypeFILE_COMPRESSION_TYPE*inoptional使用する圧縮形式を指定する入力ポインタ。NULLで自動判定する。

戻り値の型: DWORD

各言語での呼び出し定義

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

DWORD SetupDecompressOrCopyFileA(
    LPCSTR SourceFileName,
    LPCSTR TargetFileName,
    FILE_COMPRESSION_TYPE* CompressionType   // optional
);
[DllImport("SETUPAPI.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern uint SetupDecompressOrCopyFileA(
    [MarshalAs(UnmanagedType.LPStr)] string SourceFileName,   // LPCSTR
    [MarshalAs(UnmanagedType.LPStr)] string TargetFileName,   // LPCSTR
    IntPtr CompressionType   // FILE_COMPRESSION_TYPE* optional
);
<DllImport("SETUPAPI.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SetupDecompressOrCopyFileA(
    <MarshalAs(UnmanagedType.LPStr)> SourceFileName As String,   ' LPCSTR
    <MarshalAs(UnmanagedType.LPStr)> TargetFileName As String,   ' LPCSTR
    CompressionType As IntPtr   ' FILE_COMPRESSION_TYPE* optional
) As UInteger
End Function
' SourceFileName : LPCSTR
' TargetFileName : LPCSTR
' CompressionType : FILE_COMPRESSION_TYPE* optional
Declare PtrSafe Function SetupDecompressOrCopyFileA Lib "setupapi" ( _
    ByVal SourceFileName As String, _
    ByVal TargetFileName As String, _
    ByVal CompressionType As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SetupDecompressOrCopyFileA = ctypes.windll.setupapi.SetupDecompressOrCopyFileA
SetupDecompressOrCopyFileA.restype = wintypes.DWORD
SetupDecompressOrCopyFileA.argtypes = [
    wintypes.LPCSTR,  # SourceFileName : LPCSTR
    wintypes.LPCSTR,  # TargetFileName : LPCSTR
    ctypes.c_void_p,  # CompressionType : FILE_COMPRESSION_TYPE* optional
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

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

var (
	setupapi = windows.NewLazySystemDLL("SETUPAPI.dll")
	procSetupDecompressOrCopyFileA = setupapi.NewProc("SetupDecompressOrCopyFileA")
)

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

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

typedef SetupDecompressOrCopyFileANative = Uint32 Function(Pointer<Utf8>, Pointer<Utf8>, Pointer<Uint32>);
typedef SetupDecompressOrCopyFileADart = int Function(Pointer<Utf8>, Pointer<Utf8>, Pointer<Uint32>);
final SetupDecompressOrCopyFileA = DynamicLibrary.open('SETUPAPI.dll')
    .lookupFunction<SetupDecompressOrCopyFileANative, SetupDecompressOrCopyFileADart>('SetupDecompressOrCopyFileA');
// SourceFileName : LPCSTR -> Pointer<Utf8>
// TargetFileName : LPCSTR -> Pointer<Utf8>
// CompressionType : FILE_COMPRESSION_TYPE* optional -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SetupDecompressOrCopyFileA(
  SourceFileName: PAnsiChar;   // LPCSTR
  TargetFileName: PAnsiChar;   // LPCSTR
  CompressionType: Pointer   // FILE_COMPRESSION_TYPE* optional
): DWORD; stdcall;
  external 'SETUPAPI.dll' name 'SetupDecompressOrCopyFileA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SetupDecompressOrCopyFileA"
  c_SetupDecompressOrCopyFileA :: CString -> CString -> Ptr Word32 -> IO Word32
-- SourceFileName : LPCSTR -> CString
-- TargetFileName : LPCSTR -> CString
-- CompressionType : FILE_COMPRESSION_TYPE* optional -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let setupdecompressorcopyfilea =
  foreign "SetupDecompressOrCopyFileA"
    (string @-> string @-> (ptr uint32_t) @-> returning uint32_t)
(* SourceFileName : LPCSTR -> string *)
(* TargetFileName : LPCSTR -> string *)
(* CompressionType : FILE_COMPRESSION_TYPE* optional -> (ptr uint32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library setupapi (t "SETUPAPI.dll"))
(cffi:use-foreign-library setupapi)

(cffi:defcfun ("SetupDecompressOrCopyFileA" setup-decompress-or-copy-file-a :convention :stdcall) :uint32
  (source-file-name :string)   ; LPCSTR
  (target-file-name :string)   ; LPCSTR
  (compression-type :pointer))   ; FILE_COMPRESSION_TYPE* optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SetupDecompressOrCopyFileA = Win32::API::More->new('SETUPAPI',
    'DWORD SetupDecompressOrCopyFileA(LPCSTR SourceFileName, LPCSTR TargetFileName, LPVOID CompressionType)');
# my $ret = $SetupDecompressOrCopyFileA->Call($SourceFileName, $TargetFileName, $CompressionType);
# SourceFileName : LPCSTR -> LPCSTR
# TargetFileName : LPCSTR -> LPCSTR
# CompressionType : FILE_COMPRESSION_TYPE* optional -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

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