ホーム › System.DeploymentServices › WdsCliTransferImage
WdsCliTransferImage
関数WDSイメージをローカルパスへ転送し進捗を通知する。
シグネチャ
// WDSCLIENTAPI.dll
#include <windows.h>
HRESULT WdsCliTransferImage(
HANDLE hImage,
LPWSTR pwszLocalPath,
DWORD dwFlags,
DWORD dwReserved,
PFN_WdsCliCallback pfnWdsCliCallback, // optional
void* pvUserData, // optional
HANDLE* phTransfer
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| hImage | HANDLE | in | WdsCliCreateSession等で開いた転送対象イメージのハンドル。 |
| pwszLocalPath | LPWSTR | in | ダウンロード先のローカルファイルパス。 |
| dwFlags | DWORD | in | 転送動作を制御するフラグ。通常は0を指定する。 |
| dwReserved | DWORD | in | 予約済みパラメーター。0を指定する。 |
| pfnWdsCliCallback | PFN_WdsCliCallback | inoptional | 進捗通知を受け取るコールバック関数ポインタ。不要ならNULL可。 |
| pvUserData | void* | inoptional | コールバックに渡される任意のユーザーデータ。NULL可。 |
| phTransfer | HANDLE* | 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 // HRESULTfunction 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)。const std = @import("std");
extern "wdsclientapi" fn WdsCliTransferImage(
hImage: ?*anyopaque, // HANDLE
pwszLocalPath: [*c]const u16, // LPWSTR
dwFlags: u32, // DWORD
dwReserved: u32, // DWORD
pfnWdsCliCallback: ?*anyopaque, // PFN_WdsCliCallback optional
pvUserData: ?*anyopaque, // void* optional
phTransfer: ?*anyopaque // HANDLE* out
) callconv(std.os.windows.WINAPI) i32;proc WdsCliTransferImage(
hImage: pointer, # HANDLE
pwszLocalPath: WideCString, # LPWSTR
dwFlags: uint32, # DWORD
dwReserved: uint32, # DWORD
pfnWdsCliCallback: pointer, # PFN_WdsCliCallback optional
pvUserData: pointer, # void* optional
phTransfer: pointer # HANDLE* out
): int32 {.importc: "WdsCliTransferImage", stdcall, dynlib: "WDSCLIENTAPI.dll".}pragma(lib, "wdsclientapi");
extern(Windows)
int WdsCliTransferImage(
void* hImage, // HANDLE
const(wchar)* pwszLocalPath, // LPWSTR
uint dwFlags, // DWORD
uint dwReserved, // DWORD
void* pfnWdsCliCallback, // PFN_WdsCliCallback optional
void* pvUserData, // void* optional
void* phTransfer // HANDLE* out
);ccall((:WdsCliTransferImage, "WDSCLIENTAPI.dll"), stdcall, Int32,
(Ptr{Cvoid}, Cwstring, UInt32, UInt32, Ptr{Cvoid}, Ptr{Cvoid}, Ptr{Cvoid}),
hImage, pwszLocalPath, dwFlags, dwReserved, pfnWdsCliCallback, pvUserData, phTransfer)
# hImage : HANDLE -> Ptr{Cvoid}
# pwszLocalPath : LPWSTR -> Cwstring
# dwFlags : DWORD -> UInt32
# dwReserved : DWORD -> UInt32
# pfnWdsCliCallback : PFN_WdsCliCallback optional -> Ptr{Cvoid}
# pvUserData : void* optional -> Ptr{Cvoid}
# phTransfer : HANDLE* out -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
int32_t WdsCliTransferImage(
void* hImage,
const uint16_t* pwszLocalPath,
uint32_t dwFlags,
uint32_t dwReserved,
void* pfnWdsCliCallback,
void* pvUserData,
void* phTransfer);
]]
local wdsclientapi = ffi.load("wdsclientapi")
-- wdsclientapi.WdsCliTransferImage(hImage, pwszLocalPath, dwFlags, dwReserved, pfnWdsCliCallback, pvUserData, phTransfer)
-- hImage : HANDLE
-- pwszLocalPath : LPWSTR
-- dwFlags : DWORD
-- dwReserved : DWORD
-- pfnWdsCliCallback : PFN_WdsCliCallback optional
-- pvUserData : void* optional
-- phTransfer : HANDLE* out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('WDSCLIENTAPI.dll');
const WdsCliTransferImage = lib.func('__stdcall', 'WdsCliTransferImage', 'int32_t', ['void *', 'str16', 'uint32_t', 'uint32_t', 'void *', 'void *', 'void *']);
// WdsCliTransferImage(hImage, pwszLocalPath, dwFlags, dwReserved, pfnWdsCliCallback, pvUserData, phTransfer)
// hImage : HANDLE -> 'void *'
// pwszLocalPath : LPWSTR -> 'str16'
// dwFlags : DWORD -> 'uint32_t'
// dwReserved : DWORD -> 'uint32_t'
// pfnWdsCliCallback : PFN_WdsCliCallback optional -> 'void *'
// pvUserData : void* optional -> 'void *'
// phTransfer : HANDLE* out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
// コールバック(関数ポインタ)は koffi.proto/koffi.register で型を定義して渡す(素の void* では JS 関数を渡せない)。const lib = Deno.dlopen("WDSCLIENTAPI.dll", {
WdsCliTransferImage: { parameters: ["pointer", "buffer", "u32", "u32", "pointer", "pointer", "pointer"], result: "i32" },
});
// lib.symbols.WdsCliTransferImage(hImage, pwszLocalPath, dwFlags, dwReserved, pfnWdsCliCallback, pvUserData, phTransfer)
// hImage : HANDLE -> "pointer"
// pwszLocalPath : LPWSTR -> "buffer"
// dwFlags : DWORD -> "u32"
// dwReserved : DWORD -> "u32"
// pfnWdsCliCallback : PFN_WdsCliCallback optional -> "pointer"
// pvUserData : void* optional -> "pointer"
// phTransfer : HANDLE* out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t WdsCliTransferImage(
void* hImage,
const uint16_t* pwszLocalPath,
uint32_t dwFlags,
uint32_t dwReserved,
void* pfnWdsCliCallback,
void* pvUserData,
void* phTransfer);
C, "WDSCLIENTAPI.dll");
// $ffi->WdsCliTransferImage(hImage, pwszLocalPath, dwFlags, dwReserved, pfnWdsCliCallback, pvUserData, phTransfer);
// hImage : HANDLE
// pwszLocalPath : LPWSTR
// dwFlags : DWORD
// dwReserved : DWORD
// pfnWdsCliCallback : PFN_WdsCliCallback optional
// pvUserData : void* optional
// phTransfer : HANDLE* 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 Wdsclientapi extends StdCallLibrary {
Wdsclientapi INSTANCE = Native.load("wdsclientapi", Wdsclientapi.class);
int WdsCliTransferImage(
Pointer hImage, // HANDLE
WString pwszLocalPath, // LPWSTR
int dwFlags, // DWORD
int dwReserved, // DWORD
Callback pfnWdsCliCallback, // PFN_WdsCliCallback optional
Pointer pvUserData, // void* optional
Pointer phTransfer // HANDLE* out
);
}@[Link("wdsclientapi")]
lib LibWDSCLIENTAPI
fun WdsCliTransferImage = WdsCliTransferImage(
hImage : Void*, # HANDLE
pwszLocalPath : UInt16*, # LPWSTR
dwFlags : UInt32, # DWORD
dwReserved : UInt32, # DWORD
pfnWdsCliCallback : Void*, # PFN_WdsCliCallback optional
pvUserData : Void*, # void* optional
phTransfer : Void* # HANDLE* out
) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef WdsCliTransferImageNative = Int32 Function(Pointer<Void>, Pointer<Utf16>, Uint32, Uint32, Pointer<Void>, Pointer<Void>, Pointer<Void>);
typedef WdsCliTransferImageDart = int Function(Pointer<Void>, Pointer<Utf16>, int, int, Pointer<Void>, Pointer<Void>, Pointer<Void>);
final WdsCliTransferImage = DynamicLibrary.open('WDSCLIENTAPI.dll')
.lookupFunction<WdsCliTransferImageNative, WdsCliTransferImageDart>('WdsCliTransferImage');
// hImage : HANDLE -> Pointer<Void>
// pwszLocalPath : LPWSTR -> Pointer<Utf16>
// dwFlags : DWORD -> Uint32
// dwReserved : DWORD -> Uint32
// pfnWdsCliCallback : PFN_WdsCliCallback optional -> Pointer<Void>
// pvUserData : void* optional -> Pointer<Void>
// phTransfer : HANDLE* out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
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';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "WdsCliTransferImage"
c_WdsCliTransferImage :: Ptr () -> CWString -> Word32 -> Word32 -> Ptr () -> Ptr () -> Ptr () -> IO Int32
-- hImage : HANDLE -> Ptr ()
-- pwszLocalPath : LPWSTR -> CWString
-- dwFlags : DWORD -> Word32
-- dwReserved : DWORD -> Word32
-- pfnWdsCliCallback : PFN_WdsCliCallback optional -> Ptr ()
-- pvUserData : void* optional -> Ptr ()
-- phTransfer : HANDLE* out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let wdsclitransferimage =
foreign "WdsCliTransferImage"
((ptr void) @-> (ptr uint16_t) @-> uint32_t @-> uint32_t @-> (ptr void) @-> (ptr void) @-> (ptr void) @-> returning int32_t)
(* hImage : HANDLE -> (ptr void) *)
(* pwszLocalPath : LPWSTR -> (ptr uint16_t) *)
(* dwFlags : DWORD -> uint32_t *)
(* dwReserved : DWORD -> uint32_t *)
(* pfnWdsCliCallback : PFN_WdsCliCallback optional -> (ptr void) *)
(* pvUserData : void* optional -> (ptr void) *)
(* phTransfer : HANDLE* out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library wdsclientapi (t "WDSCLIENTAPI.dll"))
(cffi:use-foreign-library wdsclientapi)
(cffi:defcfun ("WdsCliTransferImage" wds-cli-transfer-image :convention :stdcall) :int32
(h-image :pointer) ; HANDLE
(pwsz-local-path (:string :encoding :utf-16le)) ; LPWSTR
(dw-flags :uint32) ; DWORD
(dw-reserved :uint32) ; DWORD
(pfn-wds-cli-callback :pointer) ; PFN_WdsCliCallback optional
(pv-user-data :pointer) ; void* optional
(ph-transfer :pointer)) ; HANDLE* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $WdsCliTransferImage = Win32::API::More->new('WDSCLIENTAPI',
'int WdsCliTransferImage(HANDLE hImage, LPCWSTR pwszLocalPath, DWORD dwFlags, DWORD dwReserved, LPVOID pfnWdsCliCallback, LPVOID pvUserData, HANDLE phTransfer)');
# my $ret = $WdsCliTransferImage->Call($hImage, $pwszLocalPath, $dwFlags, $dwReserved, $pfnWdsCliCallback, $pvUserData, $phTransfer);
# hImage : HANDLE -> HANDLE
# pwszLocalPath : LPWSTR -> LPCWSTR
# dwFlags : DWORD -> DWORD
# dwReserved : DWORD -> DWORD
# pfnWdsCliCallback : PFN_WdsCliCallback optional -> LPVOID
# pvUserData : void* optional -> LPVOID
# phTransfer : HANDLE* out -> HANDLE
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# コールバック(関数ポインタ)は Perl sub を直接渡せません。Win32::API::Callback を使用してください。関連項目
使用する型