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

SetupScanFileQueueW

関数
ファイルキュー内のファイルを検査する(Unicode)。
DLLSETUPAPI.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

BOOL SetupScanFileQueueW(
    void* FileQueue,
    SETUPSCANFILEQUEUE_FLAGS Flags,
    HWND Window,   // optional
    PSP_FILE_CALLBACK_W CallbackRoutine,   // optional
    void* CallbackContext,   // optional
    DWORD* Result
);

パラメーター

名前方向説明
FileQueuevoid*in走査対象のファイルキューのハンドル。
FlagsSETUPSCANFILEQUEUE_FLAGSinSPQ_SCAN_*系の走査動作を指定するフラグ。
WindowHWNDinoptional進捗表示用の親ウィンドウハンドル。NULL可。
CallbackRoutinePSP_FILE_CALLBACK_Winoptional走査中の通知を受け取るコールバック関数(Unicode)。
CallbackContextvoid*inoptionalコールバックへ渡すコンテキストポインタ。
ResultDWORD*out走査結果を受け取るDWORDへのポインタ(出力)。

戻り値の型: BOOL

各言語での呼び出し定義

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

BOOL SetupScanFileQueueW(
    void* FileQueue,
    SETUPSCANFILEQUEUE_FLAGS Flags,
    HWND Window,   // optional
    PSP_FILE_CALLBACK_W CallbackRoutine,   // optional
    void* CallbackContext,   // optional
    DWORD* Result
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SETUPAPI.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool SetupScanFileQueueW(
    IntPtr FileQueue,   // void*
    uint Flags,   // SETUPSCANFILEQUEUE_FLAGS
    IntPtr Window,   // HWND optional
    IntPtr CallbackRoutine,   // PSP_FILE_CALLBACK_W optional
    IntPtr CallbackContext,   // void* optional
    out uint Result   // DWORD* out
);
<DllImport("SETUPAPI.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SetupScanFileQueueW(
    FileQueue As IntPtr,   ' void*
    Flags As UInteger,   ' SETUPSCANFILEQUEUE_FLAGS
    Window As IntPtr,   ' HWND optional
    CallbackRoutine As IntPtr,   ' PSP_FILE_CALLBACK_W optional
    CallbackContext As IntPtr,   ' void* optional
    <Out> ByRef Result As UInteger   ' DWORD* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' FileQueue : void*
' Flags : SETUPSCANFILEQUEUE_FLAGS
' Window : HWND optional
' CallbackRoutine : PSP_FILE_CALLBACK_W optional
' CallbackContext : void* optional
' Result : DWORD* out
Declare PtrSafe Function SetupScanFileQueueW Lib "setupapi" ( _
    ByVal FileQueue As LongPtr, _
    ByVal Flags As Long, _
    ByVal Window As LongPtr, _
    ByVal CallbackRoutine As LongPtr, _
    ByVal CallbackContext As LongPtr, _
    ByRef Result 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

SetupScanFileQueueW = ctypes.windll.setupapi.SetupScanFileQueueW
SetupScanFileQueueW.restype = wintypes.BOOL
SetupScanFileQueueW.argtypes = [
    ctypes.POINTER(None),  # FileQueue : void*
    wintypes.DWORD,  # Flags : SETUPSCANFILEQUEUE_FLAGS
    wintypes.HANDLE,  # Window : HWND optional
    ctypes.c_void_p,  # CallbackRoutine : PSP_FILE_CALLBACK_W optional
    ctypes.POINTER(None),  # CallbackContext : void* optional
    ctypes.POINTER(wintypes.DWORD),  # Result : DWORD* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SETUPAPI.dll')
SetupScanFileQueueW = Fiddle::Function.new(
  lib['SetupScanFileQueueW'],
  [
    Fiddle::TYPE_VOIDP,  # FileQueue : void*
    -Fiddle::TYPE_INT,  # Flags : SETUPSCANFILEQUEUE_FLAGS
    Fiddle::TYPE_VOIDP,  # Window : HWND optional
    Fiddle::TYPE_VOIDP,  # CallbackRoutine : PSP_FILE_CALLBACK_W optional
    Fiddle::TYPE_VOIDP,  # CallbackContext : void* optional
    Fiddle::TYPE_VOIDP,  # Result : DWORD* out
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "setupapi")]
extern "system" {
    fn SetupScanFileQueueW(
        FileQueue: *mut (),  // void*
        Flags: u32,  // SETUPSCANFILEQUEUE_FLAGS
        Window: *mut core::ffi::c_void,  // HWND optional
        CallbackRoutine: *const core::ffi::c_void,  // PSP_FILE_CALLBACK_W optional
        CallbackContext: *mut (),  // void* optional
        Result: *mut u32  // DWORD* 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 SetupScanFileQueueW(IntPtr FileQueue, uint Flags, IntPtr Window, IntPtr CallbackRoutine, IntPtr CallbackContext, out uint Result);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SETUPAPI_SetupScanFileQueueW' -Namespace Win32 -PassThru
# $api::SetupScanFileQueueW(FileQueue, Flags, Window, CallbackRoutine, CallbackContext, Result)
#uselib "SETUPAPI.dll"
#func global SetupScanFileQueueW "SetupScanFileQueueW" wptr, wptr, wptr, wptr, wptr, wptr
; SetupScanFileQueueW FileQueue, Flags, Window, CallbackRoutine, CallbackContext, varptr(Result)   ; 戻り値は stat
; FileQueue : void* -> "wptr"
; Flags : SETUPSCANFILEQUEUE_FLAGS -> "wptr"
; Window : HWND optional -> "wptr"
; CallbackRoutine : PSP_FILE_CALLBACK_W optional -> "wptr"
; CallbackContext : void* optional -> "wptr"
; Result : DWORD* out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "SETUPAPI.dll"
#cfunc global SetupScanFileQueueW "SetupScanFileQueueW" sptr, int, sptr, sptr, sptr, var
; res = SetupScanFileQueueW(FileQueue, Flags, Window, CallbackRoutine, CallbackContext, Result)
; FileQueue : void* -> "sptr"
; Flags : SETUPSCANFILEQUEUE_FLAGS -> "int"
; Window : HWND optional -> "sptr"
; CallbackRoutine : PSP_FILE_CALLBACK_W optional -> "sptr"
; CallbackContext : void* optional -> "sptr"
; Result : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL SetupScanFileQueueW(void* FileQueue, SETUPSCANFILEQUEUE_FLAGS Flags, HWND Window, PSP_FILE_CALLBACK_W CallbackRoutine, void* CallbackContext, DWORD* Result)
#uselib "SETUPAPI.dll"
#cfunc global SetupScanFileQueueW "SetupScanFileQueueW" intptr, int, intptr, intptr, intptr, var
; res = SetupScanFileQueueW(FileQueue, Flags, Window, CallbackRoutine, CallbackContext, Result)
; FileQueue : void* -> "intptr"
; Flags : SETUPSCANFILEQUEUE_FLAGS -> "int"
; Window : HWND optional -> "intptr"
; CallbackRoutine : PSP_FILE_CALLBACK_W optional -> "intptr"
; CallbackContext : void* optional -> "intptr"
; Result : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	setupapi = windows.NewLazySystemDLL("SETUPAPI.dll")
	procSetupScanFileQueueW = setupapi.NewProc("SetupScanFileQueueW")
)

// FileQueue (void*), Flags (SETUPSCANFILEQUEUE_FLAGS), Window (HWND optional), CallbackRoutine (PSP_FILE_CALLBACK_W optional), CallbackContext (void* optional), Result (DWORD* out)
r1, _, err := procSetupScanFileQueueW.Call(
	uintptr(FileQueue),
	uintptr(Flags),
	uintptr(Window),
	uintptr(CallbackRoutine),
	uintptr(CallbackContext),
	uintptr(Result),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function SetupScanFileQueueW(
  FileQueue: Pointer;   // void*
  Flags: DWORD;   // SETUPSCANFILEQUEUE_FLAGS
  Window: THandle;   // HWND optional
  CallbackRoutine: Pointer;   // PSP_FILE_CALLBACK_W optional
  CallbackContext: Pointer;   // void* optional
  Result: Pointer   // DWORD* out
): BOOL; stdcall;
  external 'SETUPAPI.dll' name 'SetupScanFileQueueW';
result := DllCall("SETUPAPI\SetupScanFileQueueW"
    , "Ptr", FileQueue   ; void*
    , "UInt", Flags   ; SETUPSCANFILEQUEUE_FLAGS
    , "Ptr", Window   ; HWND optional
    , "Ptr", CallbackRoutine   ; PSP_FILE_CALLBACK_W optional
    , "Ptr", CallbackContext   ; void* optional
    , "Ptr", Result   ; DWORD* out
    , "Int")   ; return: BOOL
●SetupScanFileQueueW(FileQueue, Flags, Window, CallbackRoutine, CallbackContext, Result) = DLL("SETUPAPI.dll", "bool SetupScanFileQueueW(void*, dword, void*, void*, void*, void*)")
# 呼び出し: SetupScanFileQueueW(FileQueue, Flags, Window, CallbackRoutine, CallbackContext, Result)
# FileQueue : void* -> "void*"
# Flags : SETUPSCANFILEQUEUE_FLAGS -> "dword"
# Window : HWND optional -> "void*"
# CallbackRoutine : PSP_FILE_CALLBACK_W optional -> "void*"
# CallbackContext : void* optional -> "void*"
# Result : DWORD* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "setupapi" fn SetupScanFileQueueW(
    FileQueue: ?*anyopaque, // void*
    Flags: u32, // SETUPSCANFILEQUEUE_FLAGS
    Window: ?*anyopaque, // HWND optional
    CallbackRoutine: ?*anyopaque, // PSP_FILE_CALLBACK_W optional
    CallbackContext: ?*anyopaque, // void* optional
    Result: [*c]u32 // DWORD* out
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc SetupScanFileQueueW(
    FileQueue: pointer,  # void*
    Flags: uint32,  # SETUPSCANFILEQUEUE_FLAGS
    Window: pointer,  # HWND optional
    CallbackRoutine: pointer,  # PSP_FILE_CALLBACK_W optional
    CallbackContext: pointer,  # void* optional
    Result: ptr uint32  # DWORD* out
): int32 {.importc: "SetupScanFileQueueW", stdcall, dynlib: "SETUPAPI.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "setupapi");
extern(Windows)
int SetupScanFileQueueW(
    void* FileQueue,   // void*
    uint Flags,   // SETUPSCANFILEQUEUE_FLAGS
    void* Window,   // HWND optional
    void* CallbackRoutine,   // PSP_FILE_CALLBACK_W optional
    void* CallbackContext,   // void* optional
    uint* Result   // DWORD* out
);
ccall((:SetupScanFileQueueW, "SETUPAPI.dll"), stdcall, Int32,
      (Ptr{Cvoid}, UInt32, Ptr{Cvoid}, Ptr{Cvoid}, Ptr{Cvoid}, Ptr{UInt32}),
      FileQueue, Flags, Window, CallbackRoutine, CallbackContext, Result)
# FileQueue : void* -> Ptr{Cvoid}
# Flags : SETUPSCANFILEQUEUE_FLAGS -> UInt32
# Window : HWND optional -> Ptr{Cvoid}
# CallbackRoutine : PSP_FILE_CALLBACK_W optional -> Ptr{Cvoid}
# CallbackContext : void* optional -> Ptr{Cvoid}
# Result : DWORD* out -> Ptr{UInt32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
int32_t SetupScanFileQueueW(
    void* FileQueue,
    uint32_t Flags,
    void* Window,
    void* CallbackRoutine,
    void* CallbackContext,
    uint32_t* Result);
]]
local setupapi = ffi.load("setupapi")
-- setupapi.SetupScanFileQueueW(FileQueue, Flags, Window, CallbackRoutine, CallbackContext, Result)
-- FileQueue : void*
-- Flags : SETUPSCANFILEQUEUE_FLAGS
-- Window : HWND optional
-- CallbackRoutine : PSP_FILE_CALLBACK_W optional
-- CallbackContext : void* optional
-- Result : DWORD* out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('SETUPAPI.dll');
const SetupScanFileQueueW = lib.func('__stdcall', 'SetupScanFileQueueW', 'int32_t', ['void *', 'uint32_t', 'void *', 'void *', 'void *', 'uint32_t *']);
// SetupScanFileQueueW(FileQueue, Flags, Window, CallbackRoutine, CallbackContext, Result)
// FileQueue : void* -> 'void *'
// Flags : SETUPSCANFILEQUEUE_FLAGS -> 'uint32_t'
// Window : HWND optional -> 'void *'
// CallbackRoutine : PSP_FILE_CALLBACK_W optional -> 'void *'
// CallbackContext : void* optional -> 'void *'
// Result : DWORD* out -> 'uint32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
// コールバック(関数ポインタ)は koffi.proto/koffi.register で型を定義して渡す(素の void* では JS 関数を渡せない)。
const lib = Deno.dlopen("SETUPAPI.dll", {
  SetupScanFileQueueW: { parameters: ["pointer", "u32", "pointer", "pointer", "pointer", "pointer"], result: "i32" },
});
// lib.symbols.SetupScanFileQueueW(FileQueue, Flags, Window, CallbackRoutine, CallbackContext, Result)
// FileQueue : void* -> "pointer"
// Flags : SETUPSCANFILEQUEUE_FLAGS -> "u32"
// Window : HWND optional -> "pointer"
// CallbackRoutine : PSP_FILE_CALLBACK_W optional -> "pointer"
// CallbackContext : void* optional -> "pointer"
// Result : DWORD* out -> "pointer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t SetupScanFileQueueW(
    void* FileQueue,
    uint32_t Flags,
    void* Window,
    void* CallbackRoutine,
    void* CallbackContext,
    uint32_t* Result);
C, "SETUPAPI.dll");
// $ffi->SetupScanFileQueueW(FileQueue, Flags, Window, CallbackRoutine, CallbackContext, Result);
// FileQueue : void*
// Flags : SETUPSCANFILEQUEUE_FLAGS
// Window : HWND optional
// CallbackRoutine : PSP_FILE_CALLBACK_W optional
// CallbackContext : void* optional
// Result : DWORD* out
// 構造体/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.UNICODE_OPTIONS);
    boolean SetupScanFileQueueW(
        Pointer FileQueue,   // void*
        int Flags,   // SETUPSCANFILEQUEUE_FLAGS
        Pointer Window,   // HWND optional
        Callback CallbackRoutine,   // PSP_FILE_CALLBACK_W optional
        Pointer CallbackContext,   // void* optional
        IntByReference Result   // DWORD* out
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("setupapi")]
lib LibSETUPAPI
  fun SetupScanFileQueueW = SetupScanFileQueueW(
    FileQueue : Void*,   # void*
    Flags : UInt32,   # SETUPSCANFILEQUEUE_FLAGS
    Window : Void*,   # HWND optional
    CallbackRoutine : Void*,   # PSP_FILE_CALLBACK_W optional
    CallbackContext : Void*,   # void* optional
    Result : UInt32*   # DWORD* out
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef SetupScanFileQueueWNative = Int32 Function(Pointer<Void>, Uint32, Pointer<Void>, Pointer<Void>, Pointer<Void>, Pointer<Uint32>);
typedef SetupScanFileQueueWDart = int Function(Pointer<Void>, int, Pointer<Void>, Pointer<Void>, Pointer<Void>, Pointer<Uint32>);
final SetupScanFileQueueW = DynamicLibrary.open('SETUPAPI.dll')
    .lookupFunction<SetupScanFileQueueWNative, SetupScanFileQueueWDart>('SetupScanFileQueueW');
// FileQueue : void* -> Pointer<Void>
// Flags : SETUPSCANFILEQUEUE_FLAGS -> Uint32
// Window : HWND optional -> Pointer<Void>
// CallbackRoutine : PSP_FILE_CALLBACK_W optional -> Pointer<Void>
// CallbackContext : void* optional -> Pointer<Void>
// Result : DWORD* out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SetupScanFileQueueW(
  FileQueue: Pointer;   // void*
  Flags: DWORD;   // SETUPSCANFILEQUEUE_FLAGS
  Window: THandle;   // HWND optional
  CallbackRoutine: Pointer;   // PSP_FILE_CALLBACK_W optional
  CallbackContext: Pointer;   // void* optional
  Result: Pointer   // DWORD* out
): BOOL; stdcall;
  external 'SETUPAPI.dll' name 'SetupScanFileQueueW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SetupScanFileQueueW"
  c_SetupScanFileQueueW :: Ptr () -> Word32 -> Ptr () -> Ptr () -> Ptr () -> Ptr Word32 -> IO CInt
-- FileQueue : void* -> Ptr ()
-- Flags : SETUPSCANFILEQUEUE_FLAGS -> Word32
-- Window : HWND optional -> Ptr ()
-- CallbackRoutine : PSP_FILE_CALLBACK_W optional -> Ptr ()
-- CallbackContext : void* optional -> Ptr ()
-- Result : DWORD* out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let setupscanfilequeuew =
  foreign "SetupScanFileQueueW"
    ((ptr void) @-> uint32_t @-> (ptr void) @-> (ptr void) @-> (ptr void) @-> (ptr uint32_t) @-> returning int32_t)
(* FileQueue : void* -> (ptr void) *)
(* Flags : SETUPSCANFILEQUEUE_FLAGS -> uint32_t *)
(* Window : HWND optional -> (ptr void) *)
(* CallbackRoutine : PSP_FILE_CALLBACK_W optional -> (ptr void) *)
(* CallbackContext : void* optional -> (ptr void) *)
(* Result : DWORD* out -> (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 ("SetupScanFileQueueW" setup-scan-file-queue-w :convention :stdcall) :int32
  (file-queue :pointer)   ; void*
  (flags :uint32)   ; SETUPSCANFILEQUEUE_FLAGS
  (window :pointer)   ; HWND optional
  (callback-routine :pointer)   ; PSP_FILE_CALLBACK_W optional
  (callback-context :pointer)   ; void* optional
  (result :pointer))   ; DWORD* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SetupScanFileQueueW = Win32::API::More->new('SETUPAPI',
    'BOOL SetupScanFileQueueW(LPVOID FileQueue, DWORD Flags, HANDLE Window, LPVOID CallbackRoutine, LPVOID CallbackContext, LPVOID Result)');
# my $ret = $SetupScanFileQueueW->Call($FileQueue, $Flags, $Window, $CallbackRoutine, $CallbackContext, $Result);
# FileQueue : void* -> LPVOID
# Flags : SETUPSCANFILEQUEUE_FLAGS -> DWORD
# Window : HWND optional -> HANDLE
# CallbackRoutine : PSP_FILE_CALLBACK_W optional -> LPVOID
# CallbackContext : void* optional -> LPVOID
# Result : DWORD* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# コールバック(関数ポインタ)は Perl sub を直接渡せません。Win32::API::Callback を使用してください。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

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