Win32 API 日本語リファレンス
ホームSystem.DeploymentServices › WdsCliTransferImage

WdsCliTransferImage

関数
WDSイメージをローカルパスへ転送し進捗を通知する。
DLLWDSCLIENTAPI.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

HRESULT WdsCliTransferImage(
    HANDLE hImage,
    LPWSTR pwszLocalPath,
    DWORD dwFlags,
    DWORD dwReserved,
    PFN_WdsCliCallback pfnWdsCliCallback,   // optional
    void* pvUserData,   // optional
    HANDLE* phTransfer
);

パラメーター

名前方向
hImageHANDLEin
pwszLocalPathLPWSTRin
dwFlagsDWORDin
dwReservedDWORDin
pfnWdsCliCallbackPFN_WdsCliCallbackinoptional
pvUserDatavoid*inoptional
phTransferHANDLE*out

戻り値の型: HRESULT

各言語での呼び出し定義

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

HRESULT WdsCliTransferImage(
    HANDLE hImage,
    LPWSTR pwszLocalPath,
    DWORD dwFlags,
    DWORD dwReserved,
    PFN_WdsCliCallback pfnWdsCliCallback,   // optional
    void* pvUserData,   // optional
    HANDLE* phTransfer
);
[DllImport("WDSCLIENTAPI.dll", ExactSpelling = true)]
static extern int WdsCliTransferImage(
    IntPtr hImage,   // HANDLE
    [MarshalAs(UnmanagedType.LPWStr)] string pwszLocalPath,   // LPWSTR
    uint dwFlags,   // DWORD
    uint dwReserved,   // DWORD
    IntPtr pfnWdsCliCallback,   // PFN_WdsCliCallback optional
    IntPtr pvUserData,   // void* optional
    IntPtr phTransfer   // HANDLE* out
);
<DllImport("WDSCLIENTAPI.dll", ExactSpelling:=True)>
Public Shared Function WdsCliTransferImage(
    hImage As IntPtr,   ' HANDLE
    <MarshalAs(UnmanagedType.LPWStr)> pwszLocalPath As String,   ' LPWSTR
    dwFlags As UInteger,   ' DWORD
    dwReserved As UInteger,   ' DWORD
    pfnWdsCliCallback As IntPtr,   ' PFN_WdsCliCallback optional
    pvUserData As IntPtr,   ' void* optional
    phTransfer As IntPtr   ' HANDLE* out
) As Integer
End Function
' hImage : HANDLE
' pwszLocalPath : LPWSTR
' dwFlags : DWORD
' dwReserved : DWORD
' pfnWdsCliCallback : PFN_WdsCliCallback optional
' pvUserData : void* optional
' phTransfer : HANDLE* out
Declare PtrSafe Function WdsCliTransferImage Lib "wdsclientapi" ( _
    ByVal hImage As LongPtr, _
    ByVal pwszLocalPath As LongPtr, _
    ByVal dwFlags As Long, _
    ByVal dwReserved As Long, _
    ByVal pfnWdsCliCallback As LongPtr, _
    ByVal pvUserData As LongPtr, _
    ByVal phTransfer As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

WdsCliTransferImage = ctypes.windll.wdsclientapi.WdsCliTransferImage
WdsCliTransferImage.restype = ctypes.c_int
WdsCliTransferImage.argtypes = [
    wintypes.HANDLE,  # hImage : HANDLE
    wintypes.LPCWSTR,  # pwszLocalPath : LPWSTR
    wintypes.DWORD,  # dwFlags : DWORD
    wintypes.DWORD,  # dwReserved : DWORD
    ctypes.c_void_p,  # pfnWdsCliCallback : PFN_WdsCliCallback optional
    ctypes.POINTER(None),  # pvUserData : void* optional
    ctypes.c_void_p,  # phTransfer : HANDLE* out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WDSCLIENTAPI.dll')
WdsCliTransferImage = Fiddle::Function.new(
  lib['WdsCliTransferImage'],
  [
    Fiddle::TYPE_VOIDP,  # hImage : HANDLE
    Fiddle::TYPE_VOIDP,  # pwszLocalPath : LPWSTR
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
    -Fiddle::TYPE_INT,  # dwReserved : DWORD
    Fiddle::TYPE_VOIDP,  # pfnWdsCliCallback : PFN_WdsCliCallback optional
    Fiddle::TYPE_VOIDP,  # pvUserData : void* optional
    Fiddle::TYPE_VOIDP,  # phTransfer : HANDLE* out
  ],
  Fiddle::TYPE_INT)
#[link(name = "wdsclientapi")]
extern "system" {
    fn WdsCliTransferImage(
        hImage: *mut core::ffi::c_void,  // HANDLE
        pwszLocalPath: *mut u16,  // LPWSTR
        dwFlags: u32,  // DWORD
        dwReserved: u32,  // DWORD
        pfnWdsCliCallback: *const core::ffi::c_void,  // PFN_WdsCliCallback optional
        pvUserData: *mut (),  // void* optional
        phTransfer: *mut *mut core::ffi::c_void  // HANDLE* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("WDSCLIENTAPI.dll")]
public static extern int WdsCliTransferImage(IntPtr hImage, [MarshalAs(UnmanagedType.LPWStr)] string pwszLocalPath, uint dwFlags, uint dwReserved, IntPtr pfnWdsCliCallback, IntPtr pvUserData, IntPtr phTransfer);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WDSCLIENTAPI_WdsCliTransferImage' -Namespace Win32 -PassThru
# $api::WdsCliTransferImage(hImage, pwszLocalPath, dwFlags, dwReserved, pfnWdsCliCallback, pvUserData, phTransfer)
#uselib "WDSCLIENTAPI.dll"
#func global WdsCliTransferImage "WdsCliTransferImage" sptr, sptr, sptr, sptr, sptr, sptr, sptr
; WdsCliTransferImage hImage, pwszLocalPath, dwFlags, dwReserved, pfnWdsCliCallback, pvUserData, phTransfer   ; 戻り値は stat
; hImage : HANDLE -> "sptr"
; pwszLocalPath : LPWSTR -> "sptr"
; dwFlags : DWORD -> "sptr"
; dwReserved : DWORD -> "sptr"
; pfnWdsCliCallback : PFN_WdsCliCallback optional -> "sptr"
; pvUserData : void* optional -> "sptr"
; phTransfer : HANDLE* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "WDSCLIENTAPI.dll"
#cfunc global WdsCliTransferImage "WdsCliTransferImage" sptr, wstr, int, int, sptr, sptr, sptr
; res = WdsCliTransferImage(hImage, pwszLocalPath, dwFlags, dwReserved, pfnWdsCliCallback, pvUserData, phTransfer)
; hImage : HANDLE -> "sptr"
; pwszLocalPath : LPWSTR -> "wstr"
; dwFlags : DWORD -> "int"
; dwReserved : DWORD -> "int"
; pfnWdsCliCallback : PFN_WdsCliCallback optional -> "sptr"
; pvUserData : void* optional -> "sptr"
; phTransfer : HANDLE* out -> "sptr"
; HRESULT WdsCliTransferImage(HANDLE hImage, LPWSTR pwszLocalPath, DWORD dwFlags, DWORD dwReserved, PFN_WdsCliCallback pfnWdsCliCallback, void* pvUserData, HANDLE* phTransfer)
#uselib "WDSCLIENTAPI.dll"
#cfunc global WdsCliTransferImage "WdsCliTransferImage" intptr, wstr, int, int, intptr, intptr, intptr
; res = WdsCliTransferImage(hImage, pwszLocalPath, dwFlags, dwReserved, pfnWdsCliCallback, pvUserData, phTransfer)
; hImage : HANDLE -> "intptr"
; pwszLocalPath : LPWSTR -> "wstr"
; dwFlags : DWORD -> "int"
; dwReserved : DWORD -> "int"
; pfnWdsCliCallback : PFN_WdsCliCallback optional -> "intptr"
; pvUserData : void* optional -> "intptr"
; phTransfer : HANDLE* out -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	wdsclientapi = windows.NewLazySystemDLL("WDSCLIENTAPI.dll")
	procWdsCliTransferImage = wdsclientapi.NewProc("WdsCliTransferImage")
)

// hImage (HANDLE), pwszLocalPath (LPWSTR), dwFlags (DWORD), dwReserved (DWORD), pfnWdsCliCallback (PFN_WdsCliCallback optional), pvUserData (void* optional), phTransfer (HANDLE* out)
r1, _, err := procWdsCliTransferImage.Call(
	uintptr(hImage),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(pwszLocalPath))),
	uintptr(dwFlags),
	uintptr(dwReserved),
	uintptr(pfnWdsCliCallback),
	uintptr(pvUserData),
	uintptr(phTransfer),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT
function WdsCliTransferImage(
  hImage: THandle;   // HANDLE
  pwszLocalPath: PWideChar;   // LPWSTR
  dwFlags: DWORD;   // DWORD
  dwReserved: DWORD;   // DWORD
  pfnWdsCliCallback: Pointer;   // PFN_WdsCliCallback optional
  pvUserData: Pointer;   // void* optional
  phTransfer: Pointer   // HANDLE* out
): Integer; stdcall;
  external 'WDSCLIENTAPI.dll' name 'WdsCliTransferImage';
result := DllCall("WDSCLIENTAPI\WdsCliTransferImage"
    , "Ptr", hImage   ; HANDLE
    , "WStr", pwszLocalPath   ; LPWSTR
    , "UInt", dwFlags   ; DWORD
    , "UInt", dwReserved   ; DWORD
    , "Ptr", pfnWdsCliCallback   ; PFN_WdsCliCallback optional
    , "Ptr", pvUserData   ; void* optional
    , "Ptr", phTransfer   ; HANDLE* out
    , "Int")   ; return: HRESULT
●WdsCliTransferImage(hImage, pwszLocalPath, dwFlags, dwReserved, pfnWdsCliCallback, pvUserData, phTransfer) = DLL("WDSCLIENTAPI.dll", "int WdsCliTransferImage(void*, char*, dword, dword, void*, void*, void*)")
# 呼び出し: WdsCliTransferImage(hImage, pwszLocalPath, dwFlags, dwReserved, pfnWdsCliCallback, pvUserData, phTransfer)
# hImage : HANDLE -> "void*"
# pwszLocalPath : LPWSTR -> "char*"
# dwFlags : DWORD -> "dword"
# dwReserved : DWORD -> "dword"
# pfnWdsCliCallback : PFN_WdsCliCallback optional -> "void*"
# pvUserData : void* optional -> "void*"
# phTransfer : HANDLE* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。