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

SetupGetFileQueueCount

関数
ファイルキュー内の指定操作の件数を取得する。
DLLSETUPAPI.dll呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

// SETUPAPI.dll
#include <windows.h>

BOOL SetupGetFileQueueCount(
    void* FileQueue,
    DWORD SubQueueFileOp,
    DWORD* NumOperations
);

パラメーター

名前方向説明
FileQueuevoid*in操作件数を取得するファイルキューのハンドル。
SubQueueFileOpDWORDin対象とする操作種別(コピー/削除/名前変更)を指定する。
NumOperationsDWORD*out該当操作の登録件数を受け取るDWORDへのポインタ(出力)。

戻り値の型: BOOL

各言語での呼び出し定義

// SETUPAPI.dll
#include <windows.h>

BOOL SetupGetFileQueueCount(
    void* FileQueue,
    DWORD SubQueueFileOp,
    DWORD* NumOperations
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SETUPAPI.dll", SetLastError = true, ExactSpelling = true)]
static extern bool SetupGetFileQueueCount(
    IntPtr FileQueue,   // void*
    uint SubQueueFileOp,   // DWORD
    out uint NumOperations   // DWORD* out
);
<DllImport("SETUPAPI.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SetupGetFileQueueCount(
    FileQueue As IntPtr,   ' void*
    SubQueueFileOp As UInteger,   ' DWORD
    <Out> ByRef NumOperations As UInteger   ' DWORD* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' FileQueue : void*
' SubQueueFileOp : DWORD
' NumOperations : DWORD* out
Declare PtrSafe Function SetupGetFileQueueCount Lib "setupapi" ( _
    ByVal FileQueue As LongPtr, _
    ByVal SubQueueFileOp As Long, _
    ByRef NumOperations As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SetupGetFileQueueCount = ctypes.windll.setupapi.SetupGetFileQueueCount
SetupGetFileQueueCount.restype = wintypes.BOOL
SetupGetFileQueueCount.argtypes = [
    ctypes.POINTER(None),  # FileQueue : void*
    wintypes.DWORD,  # SubQueueFileOp : DWORD
    ctypes.POINTER(wintypes.DWORD),  # NumOperations : DWORD* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

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

var (
	setupapi = windows.NewLazySystemDLL("SETUPAPI.dll")
	procSetupGetFileQueueCount = setupapi.NewProc("SetupGetFileQueueCount")
)

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

extern "setupapi" fn SetupGetFileQueueCount(
    FileQueue: ?*anyopaque, // void*
    SubQueueFileOp: u32, // DWORD
    NumOperations: [*c]u32 // DWORD* out
) callconv(std.os.windows.WINAPI) i32;
proc SetupGetFileQueueCount(
    FileQueue: pointer,  # void*
    SubQueueFileOp: uint32,  # DWORD
    NumOperations: ptr uint32  # DWORD* out
): int32 {.importc: "SetupGetFileQueueCount", stdcall, dynlib: "SETUPAPI.dll".}
pragma(lib, "setupapi");
extern(Windows)
int SetupGetFileQueueCount(
    void* FileQueue,   // void*
    uint SubQueueFileOp,   // DWORD
    uint* NumOperations   // DWORD* out
);
ccall((:SetupGetFileQueueCount, "SETUPAPI.dll"), stdcall, Int32,
      (Ptr{Cvoid}, UInt32, Ptr{UInt32}),
      FileQueue, SubQueueFileOp, NumOperations)
# FileQueue : void* -> Ptr{Cvoid}
# SubQueueFileOp : DWORD -> UInt32
# NumOperations : DWORD* out -> Ptr{UInt32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t SetupGetFileQueueCount(
    void* FileQueue,
    uint32_t SubQueueFileOp,
    uint32_t* NumOperations);
]]
local setupapi = ffi.load("setupapi")
-- setupapi.SetupGetFileQueueCount(FileQueue, SubQueueFileOp, NumOperations)
-- FileQueue : void*
-- SubQueueFileOp : DWORD
-- NumOperations : DWORD* out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('SETUPAPI.dll');
const SetupGetFileQueueCount = lib.func('__stdcall', 'SetupGetFileQueueCount', 'int32_t', ['void *', 'uint32_t', 'uint32_t *']);
// SetupGetFileQueueCount(FileQueue, SubQueueFileOp, NumOperations)
// FileQueue : void* -> 'void *'
// SubQueueFileOp : DWORD -> 'uint32_t'
// NumOperations : DWORD* out -> 'uint32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("SETUPAPI.dll", {
  SetupGetFileQueueCount: { parameters: ["pointer", "u32", "pointer"], result: "i32" },
});
// lib.symbols.SetupGetFileQueueCount(FileQueue, SubQueueFileOp, NumOperations)
// FileQueue : void* -> "pointer"
// SubQueueFileOp : DWORD -> "u32"
// NumOperations : DWORD* out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t SetupGetFileQueueCount(
    void* FileQueue,
    uint32_t SubQueueFileOp,
    uint32_t* NumOperations);
C, "SETUPAPI.dll");
// $ffi->SetupGetFileQueueCount(FileQueue, SubQueueFileOp, NumOperations);
// FileQueue : void*
// SubQueueFileOp : DWORD
// NumOperations : 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);
    boolean SetupGetFileQueueCount(
        Pointer FileQueue,   // void*
        int SubQueueFileOp,   // DWORD
        IntByReference NumOperations   // DWORD* out
    );
}
@[Link("setupapi")]
lib LibSETUPAPI
  fun SetupGetFileQueueCount = SetupGetFileQueueCount(
    FileQueue : Void*,   # void*
    SubQueueFileOp : UInt32,   # DWORD
    NumOperations : 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 SetupGetFileQueueCountNative = Int32 Function(Pointer<Void>, Uint32, Pointer<Uint32>);
typedef SetupGetFileQueueCountDart = int Function(Pointer<Void>, int, Pointer<Uint32>);
final SetupGetFileQueueCount = DynamicLibrary.open('SETUPAPI.dll')
    .lookupFunction<SetupGetFileQueueCountNative, SetupGetFileQueueCountDart>('SetupGetFileQueueCount');
// FileQueue : void* -> Pointer<Void>
// SubQueueFileOp : DWORD -> Uint32
// NumOperations : DWORD* out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SetupGetFileQueueCount(
  FileQueue: Pointer;   // void*
  SubQueueFileOp: DWORD;   // DWORD
  NumOperations: Pointer   // DWORD* out
): BOOL; stdcall;
  external 'SETUPAPI.dll' name 'SetupGetFileQueueCount';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SetupGetFileQueueCount"
  c_SetupGetFileQueueCount :: Ptr () -> Word32 -> Ptr Word32 -> IO CInt
-- FileQueue : void* -> Ptr ()
-- SubQueueFileOp : DWORD -> Word32
-- NumOperations : DWORD* out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let setupgetfilequeuecount =
  foreign "SetupGetFileQueueCount"
    ((ptr void) @-> uint32_t @-> (ptr uint32_t) @-> returning int32_t)
(* FileQueue : void* -> (ptr void) *)
(* SubQueueFileOp : DWORD -> uint32_t *)
(* NumOperations : 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 ("SetupGetFileQueueCount" setup-get-file-queue-count :convention :stdcall) :int32
  (file-queue :pointer)   ; void*
  (sub-queue-file-op :uint32)   ; DWORD
  (num-operations :pointer))   ; DWORD* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SetupGetFileQueueCount = Win32::API::More->new('SETUPAPI',
    'BOOL SetupGetFileQueueCount(LPVOID FileQueue, DWORD SubQueueFileOp, LPVOID NumOperations)');
# my $ret = $SetupGetFileQueueCount->Call($FileQueue, $SubQueueFileOp, $NumOperations);
# FileQueue : void* -> LPVOID
# SubQueueFileOp : DWORD -> DWORD
# NumOperations : DWORD* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。