ホーム › Devices.DeviceAndDriverInstallation › SetupGetBackupInformationW

SetupGetBackupInformationW

関数

ファイルキューのバックアップ対象に関する情報を取得する。

DLLSETUPAPI.dll文字セットUnicode (-W)呼出規約winapi

シグネチャ

// 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

戻り値の型: 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 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   // BOOL

function 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 版の利用を推奨。