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

SetupGetFileCompressionInfoExA

関数
ソースファイルの圧縮情報を拡張バッファ指定で取得する(ANSI)。
DLLSETUPAPI.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

BOOL SetupGetFileCompressionInfoExA(
    LPCSTR SourceFileName,
    LPSTR ActualSourceFileNameBuffer,   // optional
    DWORD ActualSourceFileNameBufferLen,
    DWORD* RequiredBufferLen,   // optional
    DWORD* SourceFileSize,
    DWORD* TargetFileSize,
    FILE_COMPRESSION_TYPE* CompressionType
);

パラメーター

名前方向
SourceFileNameLPCSTRin
ActualSourceFileNameBufferLPSTRinoptional
ActualSourceFileNameBufferLenDWORDin
RequiredBufferLenDWORD*outoptional
SourceFileSizeDWORD*out
TargetFileSizeDWORD*out
CompressionTypeFILE_COMPRESSION_TYPE*out

戻り値の型: BOOL

各言語での呼び出し定義

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

BOOL SetupGetFileCompressionInfoExA(
    LPCSTR SourceFileName,
    LPSTR ActualSourceFileNameBuffer,   // optional
    DWORD ActualSourceFileNameBufferLen,
    DWORD* RequiredBufferLen,   // optional
    DWORD* SourceFileSize,
    DWORD* TargetFileSize,
    FILE_COMPRESSION_TYPE* CompressionType
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SETUPAPI.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool SetupGetFileCompressionInfoExA(
    [MarshalAs(UnmanagedType.LPStr)] string SourceFileName,   // LPCSTR
    [MarshalAs(UnmanagedType.LPStr)] string ActualSourceFileNameBuffer,   // LPSTR 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.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SetupGetFileCompressionInfoExA(
    <MarshalAs(UnmanagedType.LPStr)> SourceFileName As String,   ' LPCSTR
    <MarshalAs(UnmanagedType.LPStr)> ActualSourceFileNameBuffer As String,   ' LPSTR 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 : LPCSTR
' ActualSourceFileNameBuffer : LPSTR optional
' ActualSourceFileNameBufferLen : DWORD
' RequiredBufferLen : DWORD* optional, out
' SourceFileSize : DWORD* out
' TargetFileSize : DWORD* out
' CompressionType : FILE_COMPRESSION_TYPE* out
Declare PtrSafe Function SetupGetFileCompressionInfoExA Lib "setupapi" ( _
    ByVal SourceFileName As String, _
    ByVal ActualSourceFileNameBuffer As String, _
    ByVal ActualSourceFileNameBufferLen As Long, _
    ByVal RequiredBufferLen As LongPtr, _
    ByRef SourceFileSize As Long, _
    ByRef TargetFileSize As Long, _
    ByRef CompressionType As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SetupGetFileCompressionInfoExA = ctypes.windll.setupapi.SetupGetFileCompressionInfoExA
SetupGetFileCompressionInfoExA.restype = wintypes.BOOL
SetupGetFileCompressionInfoExA.argtypes = [
    wintypes.LPCSTR,  # SourceFileName : LPCSTR
    wintypes.LPCSTR,  # ActualSourceFileNameBuffer : LPSTR 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')
SetupGetFileCompressionInfoExA = Fiddle::Function.new(
  lib['SetupGetFileCompressionInfoExA'],
  [
    Fiddle::TYPE_VOIDP,  # SourceFileName : LPCSTR
    Fiddle::TYPE_VOIDP,  # ActualSourceFileNameBuffer : LPSTR 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)
#[link(name = "setupapi")]
extern "system" {
    fn SetupGetFileCompressionInfoExA(
        SourceFileName: *const u8,  // LPCSTR
        ActualSourceFileNameBuffer: *mut u8,  // LPSTR 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.Ansi, SetLastError = true)]
public static extern bool SetupGetFileCompressionInfoExA([MarshalAs(UnmanagedType.LPStr)] string SourceFileName, [MarshalAs(UnmanagedType.LPStr)] string ActualSourceFileNameBuffer, uint ActualSourceFileNameBufferLen, IntPtr RequiredBufferLen, out uint SourceFileSize, out uint TargetFileSize, out uint CompressionType);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SETUPAPI_SetupGetFileCompressionInfoExA' -Namespace Win32 -PassThru
# $api::SetupGetFileCompressionInfoExA(SourceFileName, ActualSourceFileNameBuffer, ActualSourceFileNameBufferLen, RequiredBufferLen, SourceFileSize, TargetFileSize, CompressionType)
#uselib "SETUPAPI.dll"
#func global SetupGetFileCompressionInfoExA "SetupGetFileCompressionInfoExA" sptr, sptr, sptr, sptr, sptr, sptr, sptr
; SetupGetFileCompressionInfoExA SourceFileName, ActualSourceFileNameBuffer, ActualSourceFileNameBufferLen, varptr(RequiredBufferLen), varptr(SourceFileSize), varptr(TargetFileSize), CompressionType   ; 戻り値は stat
; SourceFileName : LPCSTR -> "sptr"
; ActualSourceFileNameBuffer : LPSTR optional -> "sptr"
; ActualSourceFileNameBufferLen : DWORD -> "sptr"
; RequiredBufferLen : DWORD* optional, out -> "sptr"
; SourceFileSize : DWORD* out -> "sptr"
; TargetFileSize : DWORD* out -> "sptr"
; CompressionType : FILE_COMPRESSION_TYPE* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "SETUPAPI.dll"
#cfunc global SetupGetFileCompressionInfoExA "SetupGetFileCompressionInfoExA" str, str, int, var, var, var, int
; res = SetupGetFileCompressionInfoExA(SourceFileName, ActualSourceFileNameBuffer, ActualSourceFileNameBufferLen, RequiredBufferLen, SourceFileSize, TargetFileSize, CompressionType)
; SourceFileName : LPCSTR -> "str"
; ActualSourceFileNameBuffer : LPSTR optional -> "str"
; 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 SetupGetFileCompressionInfoExA(LPCSTR SourceFileName, LPSTR ActualSourceFileNameBuffer, DWORD ActualSourceFileNameBufferLen, DWORD* RequiredBufferLen, DWORD* SourceFileSize, DWORD* TargetFileSize, FILE_COMPRESSION_TYPE* CompressionType)
#uselib "SETUPAPI.dll"
#cfunc global SetupGetFileCompressionInfoExA "SetupGetFileCompressionInfoExA" str, str, int, var, var, var, int
; res = SetupGetFileCompressionInfoExA(SourceFileName, ActualSourceFileNameBuffer, ActualSourceFileNameBufferLen, RequiredBufferLen, SourceFileSize, TargetFileSize, CompressionType)
; SourceFileName : LPCSTR -> "str"
; ActualSourceFileNameBuffer : LPSTR optional -> "str"
; ActualSourceFileNameBufferLen : DWORD -> "int"
; RequiredBufferLen : DWORD* optional, out -> "var"
; SourceFileSize : DWORD* out -> "var"
; TargetFileSize : DWORD* out -> "var"
; CompressionType : FILE_COMPRESSION_TYPE* out -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	setupapi = windows.NewLazySystemDLL("SETUPAPI.dll")
	procSetupGetFileCompressionInfoExA = setupapi.NewProc("SetupGetFileCompressionInfoExA")
)

// SourceFileName (LPCSTR), ActualSourceFileNameBuffer (LPSTR optional), ActualSourceFileNameBufferLen (DWORD), RequiredBufferLen (DWORD* optional, out), SourceFileSize (DWORD* out), TargetFileSize (DWORD* out), CompressionType (FILE_COMPRESSION_TYPE* out)
r1, _, err := procSetupGetFileCompressionInfoExA.Call(
	uintptr(unsafe.Pointer(windows.BytePtrFromString(SourceFileName))),
	uintptr(unsafe.Pointer(windows.BytePtrFromString(ActualSourceFileNameBuffer))),
	uintptr(ActualSourceFileNameBufferLen),
	uintptr(RequiredBufferLen),
	uintptr(SourceFileSize),
	uintptr(TargetFileSize),
	uintptr(CompressionType),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function SetupGetFileCompressionInfoExA(
  SourceFileName: PAnsiChar;   // LPCSTR
  ActualSourceFileNameBuffer: PAnsiChar;   // LPSTR 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 'SetupGetFileCompressionInfoExA';
result := DllCall("SETUPAPI\SetupGetFileCompressionInfoExA"
    , "AStr", SourceFileName   ; LPCSTR
    , "AStr", ActualSourceFileNameBuffer   ; LPSTR 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
●SetupGetFileCompressionInfoExA(SourceFileName, ActualSourceFileNameBuffer, ActualSourceFileNameBufferLen, RequiredBufferLen, SourceFileSize, TargetFileSize, CompressionType) = DLL("SETUPAPI.dll", "bool SetupGetFileCompressionInfoExA(char*, char*, dword, void*, void*, void*, void*)")
# 呼び出し: SetupGetFileCompressionInfoExA(SourceFileName, ActualSourceFileNameBuffer, ActualSourceFileNameBufferLen, RequiredBufferLen, SourceFileSize, TargetFileSize, CompressionType)
# SourceFileName : LPCSTR -> "char*"
# ActualSourceFileNameBuffer : LPSTR 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)。