ホーム › Devices.DeviceAndDriverInstallation › SetupGetFileCompressionInfoExW

SetupGetFileCompressionInfoExW

関数

ソースファイルの圧縮情報を拡張バッファ指定で取得する(Unicode)。

DLLSETUPAPI.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

BOOL SetupGetFileCompressionInfoExW(
    LPCWSTR SourceFileName,
    LPWSTR ActualSourceFileNameBuffer,   // optional
    DWORD ActualSourceFileNameBufferLen,
    DWORD* RequiredBufferLen,   // optional
    DWORD* SourceFileSize,
    DWORD* TargetFileSize,
    FILE_COMPRESSION_TYPE* CompressionType
);

パラメーター

名前	型	方向
SourceFileName	LPCWSTR	in
ActualSourceFileNameBuffer	LPWSTR	inoptional
ActualSourceFileNameBufferLen	DWORD	in
RequiredBufferLen	DWORD*	outoptional
SourceFileSize	DWORD*	out
TargetFileSize	DWORD*	out
CompressionType	FILE_COMPRESSION_TYPE*	out

戻り値の型: BOOL

各言語での呼び出し定義

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

BOOL SetupGetFileCompressionInfoExW(
    LPCWSTR SourceFileName,
    LPWSTR ActualSourceFileNameBuffer,   // optional
    DWORD ActualSourceFileNameBufferLen,
    DWORD* RequiredBufferLen,   // optional
    DWORD* SourceFileSize,
    DWORD* TargetFileSize,
    FILE_COMPRESSION_TYPE* CompressionType
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SETUPAPI.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool SetupGetFileCompressionInfoExW(
    [MarshalAs(UnmanagedType.LPWStr)] string SourceFileName,   // LPCWSTR
    [MarshalAs(UnmanagedType.LPWStr)] string ActualSourceFileNameBuffer,   // LPWSTR optional
    uint ActualSourceFileNameBufferLen,   // DWORD
    IntPtr RequiredBufferLen,   // DWORD* optional, out
    out uint SourceFileSize,   // DWORD* out
    out uint TargetFileSize,   // DWORD* out
    out uint CompressionType   // FILE_COMPRESSION_TYPE* out
);

<DllImport("SETUPAPI.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SetupGetFileCompressionInfoExW(
    <MarshalAs(UnmanagedType.LPWStr)> SourceFileName As String,   ' LPCWSTR
    <MarshalAs(UnmanagedType.LPWStr)> ActualSourceFileNameBuffer As String,   ' LPWSTR optional
    ActualSourceFileNameBufferLen As UInteger,   ' DWORD
    RequiredBufferLen As IntPtr,   ' DWORD* optional, out
    <Out> ByRef SourceFileSize As UInteger,   ' DWORD* out
    <Out> ByRef TargetFileSize As UInteger,   ' DWORD* out
    <Out> ByRef CompressionType As UInteger   ' FILE_COMPRESSION_TYPE* out
) As Boolean
End Function

' SourceFileName : LPCWSTR
' ActualSourceFileNameBuffer : LPWSTR optional
' ActualSourceFileNameBufferLen : DWORD
' RequiredBufferLen : DWORD* optional, out
' SourceFileSize : DWORD* out
' TargetFileSize : DWORD* out
' CompressionType : FILE_COMPRESSION_TYPE* out
Declare PtrSafe Function SetupGetFileCompressionInfoExW Lib "setupapi" ( _
    ByVal SourceFileName As LongPtr, _
    ByVal ActualSourceFileNameBuffer As LongPtr, _
    ByVal ActualSourceFileNameBufferLen As Long, _
    ByVal RequiredBufferLen As LongPtr, _
    ByRef SourceFileSize As Long, _
    ByRef TargetFileSize As Long, _
    ByRef CompressionType 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

SetupGetFileCompressionInfoExW = ctypes.windll.setupapi.SetupGetFileCompressionInfoExW
SetupGetFileCompressionInfoExW.restype = wintypes.BOOL
SetupGetFileCompressionInfoExW.argtypes = [
    wintypes.LPCWSTR,  # SourceFileName : LPCWSTR
    wintypes.LPCWSTR,  # ActualSourceFileNameBuffer : LPWSTR optional
    wintypes.DWORD,  # ActualSourceFileNameBufferLen : DWORD
    ctypes.POINTER(wintypes.DWORD),  # RequiredBufferLen : DWORD* optional, out
    ctypes.POINTER(wintypes.DWORD),  # SourceFileSize : DWORD* out
    ctypes.POINTER(wintypes.DWORD),  # TargetFileSize : DWORD* out
    ctypes.c_void_p,  # CompressionType : FILE_COMPRESSION_TYPE* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SETUPAPI.dll')
SetupGetFileCompressionInfoExW = Fiddle::Function.new(
  lib['SetupGetFileCompressionInfoExW'],
  [
    Fiddle::TYPE_VOIDP,  # SourceFileName : LPCWSTR
    Fiddle::TYPE_VOIDP,  # ActualSourceFileNameBuffer : LPWSTR optional
    -Fiddle::TYPE_INT,  # ActualSourceFileNameBufferLen : DWORD
    Fiddle::TYPE_VOIDP,  # RequiredBufferLen : DWORD* optional, out
    Fiddle::TYPE_VOIDP,  # SourceFileSize : DWORD* out
    Fiddle::TYPE_VOIDP,  # TargetFileSize : DWORD* out
    Fiddle::TYPE_VOIDP,  # CompressionType : FILE_COMPRESSION_TYPE* out
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "setupapi")]
extern "system" {
    fn SetupGetFileCompressionInfoExW(
        SourceFileName: *const u16,  // LPCWSTR
        ActualSourceFileNameBuffer: *mut u16,  // LPWSTR optional
        ActualSourceFileNameBufferLen: u32,  // DWORD
        RequiredBufferLen: *mut u32,  // DWORD* optional, out
        SourceFileSize: *mut u32,  // DWORD* out
        TargetFileSize: *mut u32,  // DWORD* out
        CompressionType: *mut u32  // FILE_COMPRESSION_TYPE* 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 SetupGetFileCompressionInfoExW([MarshalAs(UnmanagedType.LPWStr)] string SourceFileName, [MarshalAs(UnmanagedType.LPWStr)] string ActualSourceFileNameBuffer, uint ActualSourceFileNameBufferLen, IntPtr RequiredBufferLen, out uint SourceFileSize, out uint TargetFileSize, out uint CompressionType);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SETUPAPI_SetupGetFileCompressionInfoExW' -Namespace Win32 -PassThru
# $api::SetupGetFileCompressionInfoExW(SourceFileName, ActualSourceFileNameBuffer, ActualSourceFileNameBufferLen, RequiredBufferLen, SourceFileSize, TargetFileSize, CompressionType)

#uselib "SETUPAPI.dll"
#func global SetupGetFileCompressionInfoExW "SetupGetFileCompressionInfoExW" wptr, wptr, wptr, wptr, wptr, wptr, wptr
; SetupGetFileCompressionInfoExW SourceFileName, ActualSourceFileNameBuffer, ActualSourceFileNameBufferLen, varptr(RequiredBufferLen), varptr(SourceFileSize), varptr(TargetFileSize), CompressionType   ; 戻り値は stat
; SourceFileName : LPCWSTR -> "wptr"
; ActualSourceFileNameBuffer : LPWSTR optional -> "wptr"
; ActualSourceFileNameBufferLen : DWORD -> "wptr"
; RequiredBufferLen : DWORD* optional, out -> "wptr"
; SourceFileSize : DWORD* out -> "wptr"
; TargetFileSize : DWORD* out -> "wptr"
; CompressionType : FILE_COMPRESSION_TYPE* out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "SETUPAPI.dll"
#cfunc global SetupGetFileCompressionInfoExW "SetupGetFileCompressionInfoExW" wstr, wstr, int, var, var, var, int
; res = SetupGetFileCompressionInfoExW(SourceFileName, ActualSourceFileNameBuffer, ActualSourceFileNameBufferLen, RequiredBufferLen, SourceFileSize, TargetFileSize, CompressionType)
; SourceFileName : LPCWSTR -> "wstr"
; ActualSourceFileNameBuffer : LPWSTR optional -> "wstr"
; ActualSourceFileNameBufferLen : DWORD -> "int"
; RequiredBufferLen : DWORD* optional, out -> "var"
; SourceFileSize : DWORD* out -> "var"
; TargetFileSize : DWORD* out -> "var"
; CompressionType : FILE_COMPRESSION_TYPE* out -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "SETUPAPI.dll"
#cfunc global SetupGetFileCompressionInfoExW "SetupGetFileCompressionInfoExW" wstr, wstr, int, sptr, sptr, sptr, int
; res = SetupGetFileCompressionInfoExW(SourceFileName, ActualSourceFileNameBuffer, ActualSourceFileNameBufferLen, varptr(RequiredBufferLen), varptr(SourceFileSize), varptr(TargetFileSize), CompressionType)
; SourceFileName : LPCWSTR -> "wstr"
; ActualSourceFileNameBuffer : LPWSTR optional -> "wstr"
; ActualSourceFileNameBufferLen : DWORD -> "int"
; RequiredBufferLen : DWORD* optional, out -> "sptr"
; SourceFileSize : DWORD* out -> "sptr"
; TargetFileSize : DWORD* out -> "sptr"
; CompressionType : FILE_COMPRESSION_TYPE* out -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。

出力引数:

; BOOL SetupGetFileCompressionInfoExW(LPCWSTR SourceFileName, LPWSTR ActualSourceFileNameBuffer, DWORD ActualSourceFileNameBufferLen, DWORD* RequiredBufferLen, DWORD* SourceFileSize, DWORD* TargetFileSize, FILE_COMPRESSION_TYPE* CompressionType)
#uselib "SETUPAPI.dll"
#cfunc global SetupGetFileCompressionInfoExW "SetupGetFileCompressionInfoExW" wstr, wstr, int, var, var, var, int
; res = SetupGetFileCompressionInfoExW(SourceFileName, ActualSourceFileNameBuffer, ActualSourceFileNameBufferLen, RequiredBufferLen, SourceFileSize, TargetFileSize, CompressionType)
; SourceFileName : LPCWSTR -> "wstr"
; ActualSourceFileNameBuffer : LPWSTR optional -> "wstr"
; ActualSourceFileNameBufferLen : DWORD -> "int"
; RequiredBufferLen : DWORD* optional, out -> "var"
; SourceFileSize : DWORD* out -> "var"
; TargetFileSize : DWORD* out -> "var"
; CompressionType : FILE_COMPRESSION_TYPE* out -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; BOOL SetupGetFileCompressionInfoExW(LPCWSTR SourceFileName, LPWSTR ActualSourceFileNameBuffer, DWORD ActualSourceFileNameBufferLen, DWORD* RequiredBufferLen, DWORD* SourceFileSize, DWORD* TargetFileSize, FILE_COMPRESSION_TYPE* CompressionType)
#uselib "SETUPAPI.dll"
#cfunc global SetupGetFileCompressionInfoExW "SetupGetFileCompressionInfoExW" wstr, wstr, int, intptr, intptr, intptr, int
; res = SetupGetFileCompressionInfoExW(SourceFileName, ActualSourceFileNameBuffer, ActualSourceFileNameBufferLen, varptr(RequiredBufferLen), varptr(SourceFileSize), varptr(TargetFileSize), CompressionType)
; SourceFileName : LPCWSTR -> "wstr"
; ActualSourceFileNameBuffer : LPWSTR optional -> "wstr"
; ActualSourceFileNameBufferLen : DWORD -> "int"
; RequiredBufferLen : DWORD* optional, out -> "intptr"
; SourceFileSize : DWORD* out -> "intptr"
; TargetFileSize : DWORD* out -> "intptr"
; CompressionType : FILE_COMPRESSION_TYPE* out -> "int"
; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。

import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	setupapi = windows.NewLazySystemDLL("SETUPAPI.dll")
	procSetupGetFileCompressionInfoExW = setupapi.NewProc("SetupGetFileCompressionInfoExW")
)

// SourceFileName (LPCWSTR), ActualSourceFileNameBuffer (LPWSTR optional), ActualSourceFileNameBufferLen (DWORD), RequiredBufferLen (DWORD* optional, out), SourceFileSize (DWORD* out), TargetFileSize (DWORD* out), CompressionType (FILE_COMPRESSION_TYPE* out)
r1, _, err := procSetupGetFileCompressionInfoExW.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(SourceFileName))),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(ActualSourceFileNameBuffer))),
	uintptr(ActualSourceFileNameBufferLen),
	uintptr(RequiredBufferLen),
	uintptr(SourceFileSize),
	uintptr(TargetFileSize),
	uintptr(CompressionType),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL

function SetupGetFileCompressionInfoExW(
  SourceFileName: PWideChar;   // LPCWSTR
  ActualSourceFileNameBuffer: PWideChar;   // LPWSTR optional
  ActualSourceFileNameBufferLen: DWORD;   // DWORD
  RequiredBufferLen: Pointer;   // DWORD* optional, out
  SourceFileSize: Pointer;   // DWORD* out
  TargetFileSize: Pointer;   // DWORD* out
  CompressionType: Pointer   // FILE_COMPRESSION_TYPE* out
): BOOL; stdcall;
  external 'SETUPAPI.dll' name 'SetupGetFileCompressionInfoExW';

result := DllCall("SETUPAPI\SetupGetFileCompressionInfoExW"
    , "WStr", SourceFileName   ; LPCWSTR
    , "WStr", ActualSourceFileNameBuffer   ; LPWSTR optional
    , "UInt", ActualSourceFileNameBufferLen   ; DWORD
    , "Ptr", RequiredBufferLen   ; DWORD* optional, out
    , "Ptr", SourceFileSize   ; DWORD* out
    , "Ptr", TargetFileSize   ; DWORD* out
    , "Ptr", CompressionType   ; FILE_COMPRESSION_TYPE* out
    , "Int")   ; return: BOOL

●SetupGetFileCompressionInfoExW(SourceFileName, ActualSourceFileNameBuffer, ActualSourceFileNameBufferLen, RequiredBufferLen, SourceFileSize, TargetFileSize, CompressionType) = DLL("SETUPAPI.dll", "bool SetupGetFileCompressionInfoExW(char*, char*, dword, void*, void*, void*, void*)")
# 呼び出し: SetupGetFileCompressionInfoExW(SourceFileName, ActualSourceFileNameBuffer, ActualSourceFileNameBufferLen, RequiredBufferLen, SourceFileSize, TargetFileSize, CompressionType)
# SourceFileName : LPCWSTR -> "char*"
# ActualSourceFileNameBuffer : LPWSTR optional -> "char*"
# ActualSourceFileNameBufferLen : DWORD -> "dword"
# RequiredBufferLen : DWORD* optional, out -> "void*"
# SourceFileSize : DWORD* out -> "void*"
# TargetFileSize : DWORD* out -> "void*"
# CompressionType : FILE_COMPRESSION_TYPE* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。