ホーム › Devices.DeviceAndDriverInstallation › SetupGetBackupInformationW
SetupGetBackupInformationW
関数ファイルキューのバックアップ対象に関する情報を取得する。
シグネチャ
// SETUPAPI.dll (Unicode / -W)
#include <windows.h>
BOOL SetupGetBackupInformationW(
void* QueueHandle,
SP_BACKUP_QUEUE_PARAMS_V2_W* BackupParams
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| QueueHandle | void* | in | バックアップ情報を取得するファイルキューのハンドル。 |
| BackupParams | SP_BACKUP_QUEUE_PARAMS_V2_W* | inout | バックアップ情報を受け取るSP_BACKUP_QUEUE_PARAMS_V2_W構造体へのポインタ(出力)。 |
戻り値の型: BOOL
各言語での呼び出し定義
// SETUPAPI.dll (Unicode / -W)
#include <windows.h>
BOOL SetupGetBackupInformationW(
void* QueueHandle,
SP_BACKUP_QUEUE_PARAMS_V2_W* BackupParams
);[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SETUPAPI.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern bool SetupGetBackupInformationW(
IntPtr QueueHandle, // void*
IntPtr BackupParams // SP_BACKUP_QUEUE_PARAMS_V2_W* in/out
);<DllImport("SETUPAPI.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function SetupGetBackupInformationW(
QueueHandle As IntPtr, ' void*
BackupParams As IntPtr ' SP_BACKUP_QUEUE_PARAMS_V2_W* in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function' QueueHandle : void*
' BackupParams : SP_BACKUP_QUEUE_PARAMS_V2_W* in/out
Declare PtrSafe Function SetupGetBackupInformationW Lib "setupapi" ( _
ByVal QueueHandle As LongPtr, _
ByVal BackupParams As LongPtr) 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
SetupGetBackupInformationW = ctypes.windll.setupapi.SetupGetBackupInformationW
SetupGetBackupInformationW.restype = wintypes.BOOL
SetupGetBackupInformationW.argtypes = [
ctypes.POINTER(None), # QueueHandle : void*
ctypes.c_void_p, # BackupParams : SP_BACKUP_QUEUE_PARAMS_V2_W* in/out
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('SETUPAPI.dll')
SetupGetBackupInformationW = Fiddle::Function.new(
lib['SetupGetBackupInformationW'],
[
Fiddle::TYPE_VOIDP, # QueueHandle : void*
Fiddle::TYPE_VOIDP, # BackupParams : SP_BACKUP_QUEUE_PARAMS_V2_W* in/out
],
Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"#[link(name = "setupapi")]
extern "system" {
fn SetupGetBackupInformationW(
QueueHandle: *mut (), // void*
BackupParams: *mut SP_BACKUP_QUEUE_PARAMS_V2_W // SP_BACKUP_QUEUE_PARAMS_V2_W* in/out
) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SETUPAPI.dll", CharSet = CharSet.Unicode)]
public static extern bool SetupGetBackupInformationW(IntPtr QueueHandle, IntPtr BackupParams);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SETUPAPI_SetupGetBackupInformationW' -Namespace Win32 -PassThru
# $api::SetupGetBackupInformationW(QueueHandle, BackupParams)#uselib "SETUPAPI.dll"
#func global SetupGetBackupInformationW "SetupGetBackupInformationW" wptr, wptr
; SetupGetBackupInformationW QueueHandle, varptr(BackupParams) ; 戻り値は stat
; QueueHandle : void* -> "wptr"
; BackupParams : SP_BACKUP_QUEUE_PARAMS_V2_W* in/out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。出力引数:
#uselib "SETUPAPI.dll" #cfunc global SetupGetBackupInformationW "SetupGetBackupInformationW" sptr, var ; res = SetupGetBackupInformationW(QueueHandle, BackupParams) ; QueueHandle : void* -> "sptr" ; BackupParams : SP_BACKUP_QUEUE_PARAMS_V2_W* in/out -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "SETUPAPI.dll" #cfunc global SetupGetBackupInformationW "SetupGetBackupInformationW" sptr, sptr ; res = SetupGetBackupInformationW(QueueHandle, varptr(BackupParams)) ; QueueHandle : void* -> "sptr" ; BackupParams : SP_BACKUP_QUEUE_PARAMS_V2_W* in/out -> "sptr" ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
出力引数:
; BOOL SetupGetBackupInformationW(void* QueueHandle, SP_BACKUP_QUEUE_PARAMS_V2_W* BackupParams) #uselib "SETUPAPI.dll" #cfunc global SetupGetBackupInformationW "SetupGetBackupInformationW" intptr, var ; res = SetupGetBackupInformationW(QueueHandle, BackupParams) ; QueueHandle : void* -> "intptr" ; BackupParams : SP_BACKUP_QUEUE_PARAMS_V2_W* in/out -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; BOOL SetupGetBackupInformationW(void* QueueHandle, SP_BACKUP_QUEUE_PARAMS_V2_W* BackupParams) #uselib "SETUPAPI.dll" #cfunc global SetupGetBackupInformationW "SetupGetBackupInformationW" intptr, intptr ; res = SetupGetBackupInformationW(QueueHandle, varptr(BackupParams)) ; QueueHandle : void* -> "intptr" ; BackupParams : SP_BACKUP_QUEUE_PARAMS_V2_W* in/out -> "intptr" ; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。
import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
setupapi = windows.NewLazySystemDLL("SETUPAPI.dll")
procSetupGetBackupInformationW = setupapi.NewProc("SetupGetBackupInformationW")
)
// QueueHandle (void*), BackupParams (SP_BACKUP_QUEUE_PARAMS_V2_W* in/out)
r1, _, err := procSetupGetBackupInformationW.Call(
uintptr(QueueHandle),
uintptr(BackupParams),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // BOOLfunction SetupGetBackupInformationW(
QueueHandle: Pointer; // void*
BackupParams: Pointer // SP_BACKUP_QUEUE_PARAMS_V2_W* in/out
): BOOL; stdcall;
external 'SETUPAPI.dll' name 'SetupGetBackupInformationW';result := DllCall("SETUPAPI\SetupGetBackupInformationW"
, "Ptr", QueueHandle ; void*
, "Ptr", BackupParams ; SP_BACKUP_QUEUE_PARAMS_V2_W* in/out
, "Int") ; return: BOOL●SetupGetBackupInformationW(QueueHandle, BackupParams) = DLL("SETUPAPI.dll", "bool SetupGetBackupInformationW(void*, void*)")
# 呼び出し: SetupGetBackupInformationW(QueueHandle, BackupParams)
# QueueHandle : void* -> "void*"
# BackupParams : SP_BACKUP_QUEUE_PARAMS_V2_W* in/out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。const std = @import("std");
extern "setupapi" fn SetupGetBackupInformationW(
QueueHandle: ?*anyopaque, // void*
BackupParams: [*c]SP_BACKUP_QUEUE_PARAMS_V2_W // SP_BACKUP_QUEUE_PARAMS_V2_W* in/out
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。proc SetupGetBackupInformationW(
QueueHandle: pointer, # void*
BackupParams: ptr SP_BACKUP_QUEUE_PARAMS_V2_W # SP_BACKUP_QUEUE_PARAMS_V2_W* in/out
): int32 {.importc: "SetupGetBackupInformationW", stdcall, dynlib: "SETUPAPI.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。pragma(lib, "setupapi");
extern(Windows)
int SetupGetBackupInformationW(
void* QueueHandle, // void*
SP_BACKUP_QUEUE_PARAMS_V2_W* BackupParams // SP_BACKUP_QUEUE_PARAMS_V2_W* in/out
);ccall((:SetupGetBackupInformationW, "SETUPAPI.dll"), stdcall, Int32,
(Ptr{Cvoid}, Ptr{SP_BACKUP_QUEUE_PARAMS_V2_W}),
QueueHandle, BackupParams)
# QueueHandle : void* -> Ptr{Cvoid}
# BackupParams : SP_BACKUP_QUEUE_PARAMS_V2_W* in/out -> Ptr{SP_BACKUP_QUEUE_PARAMS_V2_W}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。local ffi = require("ffi")
ffi.cdef[[
int32_t SetupGetBackupInformationW(
void* QueueHandle,
void* BackupParams);
]]
local setupapi = ffi.load("setupapi")
-- setupapi.SetupGetBackupInformationW(QueueHandle, BackupParams)
-- QueueHandle : void*
-- BackupParams : SP_BACKUP_QUEUE_PARAMS_V2_W* in/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 SetupGetBackupInformationW = lib.func('__stdcall', 'SetupGetBackupInformationW', 'int32_t', ['void *', 'void *']);
// SetupGetBackupInformationW(QueueHandle, BackupParams)
// QueueHandle : void* -> 'void *'
// BackupParams : SP_BACKUP_QUEUE_PARAMS_V2_W* in/out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("SETUPAPI.dll", {
SetupGetBackupInformationW: { parameters: ["pointer", "pointer"], result: "i32" },
});
// lib.symbols.SetupGetBackupInformationW(QueueHandle, BackupParams)
// QueueHandle : void* -> "pointer"
// BackupParams : SP_BACKUP_QUEUE_PARAMS_V2_W* in/out -> "pointer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t SetupGetBackupInformationW(
void* QueueHandle,
void* BackupParams);
C, "SETUPAPI.dll");
// $ffi->SetupGetBackupInformationW(QueueHandle, BackupParams);
// QueueHandle : void*
// BackupParams : SP_BACKUP_QUEUE_PARAMS_V2_W* in/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 SetupGetBackupInformationW(
Pointer QueueHandle, // void*
Pointer BackupParams // SP_BACKUP_QUEUE_PARAMS_V2_W* in/out
);
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。@[Link("setupapi")]
lib LibSETUPAPI
fun SetupGetBackupInformationW = SetupGetBackupInformationW(
QueueHandle : Void*, # void*
BackupParams : SP_BACKUP_QUEUE_PARAMS_V2_W* # SP_BACKUP_QUEUE_PARAMS_V2_W* in/out
) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef SetupGetBackupInformationWNative = Int32 Function(Pointer<Void>, Pointer<Void>);
typedef SetupGetBackupInformationWDart = int Function(Pointer<Void>, Pointer<Void>);
final SetupGetBackupInformationW = DynamicLibrary.open('SETUPAPI.dll')
.lookupFunction<SetupGetBackupInformationWNative, SetupGetBackupInformationWDart>('SetupGetBackupInformationW');
// QueueHandle : void* -> Pointer<Void>
// BackupParams : SP_BACKUP_QUEUE_PARAMS_V2_W* in/out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function SetupGetBackupInformationW(
QueueHandle: Pointer; // void*
BackupParams: Pointer // SP_BACKUP_QUEUE_PARAMS_V2_W* in/out
): BOOL; stdcall;
external 'SETUPAPI.dll' name 'SetupGetBackupInformationW';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "SetupGetBackupInformationW"
c_SetupGetBackupInformationW :: Ptr () -> Ptr () -> IO CInt
-- QueueHandle : void* -> Ptr ()
-- BackupParams : SP_BACKUP_QUEUE_PARAMS_V2_W* in/out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let setupgetbackupinformationw =
foreign "SetupGetBackupInformationW"
((ptr void) @-> (ptr void) @-> returning int32_t)
(* QueueHandle : void* -> (ptr void) *)
(* BackupParams : SP_BACKUP_QUEUE_PARAMS_V2_W* in/out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library setupapi (t "SETUPAPI.dll"))
(cffi:use-foreign-library setupapi)
(cffi:defcfun ("SetupGetBackupInformationW" setup-get-backup-information-w :convention :stdcall) :int32
(queue-handle :pointer) ; void*
(backup-params :pointer)) ; SP_BACKUP_QUEUE_PARAMS_V2_W* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $SetupGetBackupInformationW = Win32::API::More->new('SETUPAPI',
'BOOL SetupGetBackupInformationW(LPVOID QueueHandle, LPVOID BackupParams)');
# my $ret = $SetupGetBackupInformationW->Call($QueueHandle, $BackupParams);
# QueueHandle : void* -> LPVOID
# BackupParams : SP_BACKUP_QUEUE_PARAMS_V2_W* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。関連項目
文字セット違い
- f SetupGetBackupInformationA (ANSI版) — ファイルキューのバックアップ対象に関する情報を取得する。