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

SetupIterateCabinetA

関数
キャビネット内の各ファイルを列挙しコールバックに通知する。
DLLSETUPAPI.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

BOOL SetupIterateCabinetA(
    LPCSTR CabinetFile,
    DWORD Reserved,   // optional
    PSP_FILE_CALLBACK_A MsgHandler,
    void* Context
);

パラメーター

名前方向説明
CabinetFileLPCSTRin列挙対象のキャビネット(.cab)ファイルのパス(ANSI)。
ReservedDWORDoptional予約済み。0を指定する必要がある。
MsgHandlerPSP_FILE_CALLBACK_Ain各ファイルごとに呼ばれるコールバック関数(ANSI)。
Contextvoid*inコールバックへ渡すユーザー定義のコンテキストポインタ。

戻り値の型: BOOL

各言語での呼び出し定義

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

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

SetupIterateCabinetA = ctypes.windll.setupapi.SetupIterateCabinetA
SetupIterateCabinetA.restype = wintypes.BOOL
SetupIterateCabinetA.argtypes = [
    wintypes.LPCSTR,  # CabinetFile : LPCSTR
    wintypes.DWORD,  # Reserved : DWORD optional
    ctypes.c_void_p,  # MsgHandler : PSP_FILE_CALLBACK_A
    ctypes.POINTER(None),  # Context : void*
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SETUPAPI.dll')
SetupIterateCabinetA = Fiddle::Function.new(
  lib['SetupIterateCabinetA'],
  [
    Fiddle::TYPE_VOIDP,  # CabinetFile : LPCSTR
    -Fiddle::TYPE_INT,  # Reserved : DWORD optional
    Fiddle::TYPE_VOIDP,  # MsgHandler : PSP_FILE_CALLBACK_A
    Fiddle::TYPE_VOIDP,  # Context : void*
  ],
  Fiddle::TYPE_INT)
#[link(name = "setupapi")]
extern "system" {
    fn SetupIterateCabinetA(
        CabinetFile: *const u8,  // LPCSTR
        Reserved: u32,  // DWORD optional
        MsgHandler: *const core::ffi::c_void,  // PSP_FILE_CALLBACK_A
        Context: *mut ()  // void*
    ) -> 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 SetupIterateCabinetA([MarshalAs(UnmanagedType.LPStr)] string CabinetFile, uint Reserved, IntPtr MsgHandler, IntPtr Context);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SETUPAPI_SetupIterateCabinetA' -Namespace Win32 -PassThru
# $api::SetupIterateCabinetA(CabinetFile, Reserved, MsgHandler, Context)
#uselib "SETUPAPI.dll"
#func global SetupIterateCabinetA "SetupIterateCabinetA" sptr, sptr, sptr, sptr
; SetupIterateCabinetA CabinetFile, Reserved, MsgHandler, Context   ; 戻り値は stat
; CabinetFile : LPCSTR -> "sptr"
; Reserved : DWORD optional -> "sptr"
; MsgHandler : PSP_FILE_CALLBACK_A -> "sptr"
; Context : void* -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "SETUPAPI.dll"
#cfunc global SetupIterateCabinetA "SetupIterateCabinetA" str, int, sptr, sptr
; res = SetupIterateCabinetA(CabinetFile, Reserved, MsgHandler, Context)
; CabinetFile : LPCSTR -> "str"
; Reserved : DWORD optional -> "int"
; MsgHandler : PSP_FILE_CALLBACK_A -> "sptr"
; Context : void* -> "sptr"
; BOOL SetupIterateCabinetA(LPCSTR CabinetFile, DWORD Reserved, PSP_FILE_CALLBACK_A MsgHandler, void* Context)
#uselib "SETUPAPI.dll"
#cfunc global SetupIterateCabinetA "SetupIterateCabinetA" str, int, intptr, intptr
; res = SetupIterateCabinetA(CabinetFile, Reserved, MsgHandler, Context)
; CabinetFile : LPCSTR -> "str"
; Reserved : DWORD optional -> "int"
; MsgHandler : PSP_FILE_CALLBACK_A -> "intptr"
; Context : void* -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	setupapi = windows.NewLazySystemDLL("SETUPAPI.dll")
	procSetupIterateCabinetA = setupapi.NewProc("SetupIterateCabinetA")
)

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

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

typedef SetupIterateCabinetANative = Int32 Function(Pointer<Utf8>, Uint32, Pointer<Void>, Pointer<Void>);
typedef SetupIterateCabinetADart = int Function(Pointer<Utf8>, int, Pointer<Void>, Pointer<Void>);
final SetupIterateCabinetA = DynamicLibrary.open('SETUPAPI.dll')
    .lookupFunction<SetupIterateCabinetANative, SetupIterateCabinetADart>('SetupIterateCabinetA');
// CabinetFile : LPCSTR -> Pointer<Utf8>
// Reserved : DWORD optional -> Uint32
// MsgHandler : PSP_FILE_CALLBACK_A -> Pointer<Void>
// Context : void* -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SetupIterateCabinetA(
  CabinetFile: PAnsiChar;   // LPCSTR
  Reserved: DWORD;   // DWORD optional
  MsgHandler: Pointer;   // PSP_FILE_CALLBACK_A
  Context: Pointer   // void*
): BOOL; stdcall;
  external 'SETUPAPI.dll' name 'SetupIterateCabinetA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SetupIterateCabinetA"
  c_SetupIterateCabinetA :: CString -> Word32 -> Ptr () -> Ptr () -> IO CInt
-- CabinetFile : LPCSTR -> CString
-- Reserved : DWORD optional -> Word32
-- MsgHandler : PSP_FILE_CALLBACK_A -> Ptr ()
-- Context : void* -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let setupiteratecabineta =
  foreign "SetupIterateCabinetA"
    (string @-> uint32_t @-> (ptr void) @-> (ptr void) @-> returning int32_t)
(* CabinetFile : LPCSTR -> string *)
(* Reserved : DWORD optional -> uint32_t *)
(* MsgHandler : PSP_FILE_CALLBACK_A -> (ptr void) *)
(* Context : void* -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library setupapi (t "SETUPAPI.dll"))
(cffi:use-foreign-library setupapi)

(cffi:defcfun ("SetupIterateCabinetA" setup-iterate-cabinet-a :convention :stdcall) :int32
  (cabinet-file :string)   ; LPCSTR
  (reserved :uint32)   ; DWORD optional
  (msg-handler :pointer)   ; PSP_FILE_CALLBACK_A
  (context :pointer))   ; void*
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SetupIterateCabinetA = Win32::API::More->new('SETUPAPI',
    'BOOL SetupIterateCabinetA(LPCSTR CabinetFile, DWORD Reserved, LPVOID MsgHandler, LPVOID Context)');
# my $ret = $SetupIterateCabinetA->Call($CabinetFile, $Reserved, $MsgHandler, $Context);
# CabinetFile : LPCSTR -> LPCSTR
# Reserved : DWORD optional -> DWORD
# MsgHandler : PSP_FILE_CALLBACK_A -> LPVOID
# Context : void* -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# コールバック(関数ポインタ)は Perl sub を直接渡せません。Win32::API::Callback を使用してください。

関連項目

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