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

WdsCliCancelTransfer

関数
進行中のWDS転送を取り消す。
DLLWDSCLIENTAPI.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

HRESULT WdsCliCancelTransfer(
    HANDLE hTransfer
);

パラメーター

名前方向説明
hTransferHANDLEinWdsCliTransferImage/Fileで取得した転送ハンドル。進行中の転送を中止する。

戻り値の型: HRESULT

各言語での呼び出し定義

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

HRESULT WdsCliCancelTransfer(
    HANDLE hTransfer
);
[DllImport("WDSCLIENTAPI.dll", ExactSpelling = true)]
static extern int WdsCliCancelTransfer(
    IntPtr hTransfer   // HANDLE
);
<DllImport("WDSCLIENTAPI.dll", ExactSpelling:=True)>
Public Shared Function WdsCliCancelTransfer(
    hTransfer As IntPtr   ' HANDLE
) As Integer
End Function
' hTransfer : HANDLE
Declare PtrSafe Function WdsCliCancelTransfer Lib "wdsclientapi" ( _
    ByVal hTransfer As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

WdsCliCancelTransfer = ctypes.windll.wdsclientapi.WdsCliCancelTransfer
WdsCliCancelTransfer.restype = ctypes.c_int
WdsCliCancelTransfer.argtypes = [
    wintypes.HANDLE,  # hTransfer : HANDLE
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WDSCLIENTAPI.dll')
WdsCliCancelTransfer = Fiddle::Function.new(
  lib['WdsCliCancelTransfer'],
  [
    Fiddle::TYPE_VOIDP,  # hTransfer : HANDLE
  ],
  Fiddle::TYPE_INT)
#[link(name = "wdsclientapi")]
extern "system" {
    fn WdsCliCancelTransfer(
        hTransfer: *mut core::ffi::c_void  // HANDLE
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("WDSCLIENTAPI.dll")]
public static extern int WdsCliCancelTransfer(IntPtr hTransfer);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WDSCLIENTAPI_WdsCliCancelTransfer' -Namespace Win32 -PassThru
# $api::WdsCliCancelTransfer(hTransfer)
#uselib "WDSCLIENTAPI.dll"
#func global WdsCliCancelTransfer "WdsCliCancelTransfer" sptr
; WdsCliCancelTransfer hTransfer   ; 戻り値は stat
; hTransfer : HANDLE -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "WDSCLIENTAPI.dll"
#cfunc global WdsCliCancelTransfer "WdsCliCancelTransfer" sptr
; res = WdsCliCancelTransfer(hTransfer)
; hTransfer : HANDLE -> "sptr"
; HRESULT WdsCliCancelTransfer(HANDLE hTransfer)
#uselib "WDSCLIENTAPI.dll"
#cfunc global WdsCliCancelTransfer "WdsCliCancelTransfer" intptr
; res = WdsCliCancelTransfer(hTransfer)
; hTransfer : HANDLE -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	wdsclientapi = windows.NewLazySystemDLL("WDSCLIENTAPI.dll")
	procWdsCliCancelTransfer = wdsclientapi.NewProc("WdsCliCancelTransfer")
)

// hTransfer (HANDLE)
r1, _, err := procWdsCliCancelTransfer.Call(
	uintptr(hTransfer),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT
function WdsCliCancelTransfer(
  hTransfer: THandle   // HANDLE
): Integer; stdcall;
  external 'WDSCLIENTAPI.dll' name 'WdsCliCancelTransfer';
result := DllCall("WDSCLIENTAPI\WdsCliCancelTransfer"
    , "Ptr", hTransfer   ; HANDLE
    , "Int")   ; return: HRESULT
●WdsCliCancelTransfer(hTransfer) = DLL("WDSCLIENTAPI.dll", "int WdsCliCancelTransfer(void*)")
# 呼び出し: WdsCliCancelTransfer(hTransfer)
# hTransfer : HANDLE -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "wdsclientapi" fn WdsCliCancelTransfer(
    hTransfer: ?*anyopaque // HANDLE
) callconv(std.os.windows.WINAPI) i32;
proc WdsCliCancelTransfer(
    hTransfer: pointer  # HANDLE
): int32 {.importc: "WdsCliCancelTransfer", stdcall, dynlib: "WDSCLIENTAPI.dll".}
pragma(lib, "wdsclientapi");
extern(Windows)
int WdsCliCancelTransfer(
    void* hTransfer   // HANDLE
);
ccall((:WdsCliCancelTransfer, "WDSCLIENTAPI.dll"), stdcall, Int32,
      (Ptr{Cvoid},),
      hTransfer)
# hTransfer : HANDLE -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t WdsCliCancelTransfer(
    void* hTransfer);
]]
local wdsclientapi = ffi.load("wdsclientapi")
-- wdsclientapi.WdsCliCancelTransfer(hTransfer)
-- hTransfer : HANDLE
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('WDSCLIENTAPI.dll');
const WdsCliCancelTransfer = lib.func('__stdcall', 'WdsCliCancelTransfer', 'int32_t', ['void *']);
// WdsCliCancelTransfer(hTransfer)
// hTransfer : HANDLE -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("WDSCLIENTAPI.dll", {
  WdsCliCancelTransfer: { parameters: ["pointer"], result: "i32" },
});
// lib.symbols.WdsCliCancelTransfer(hTransfer)
// hTransfer : HANDLE -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t WdsCliCancelTransfer(
    void* hTransfer);
C, "WDSCLIENTAPI.dll");
// $ffi->WdsCliCancelTransfer(hTransfer);
// hTransfer : HANDLE
// 構造体/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 WdsCliCancelTransfer(
        Pointer hTransfer   // HANDLE
    );
}
@[Link("wdsclientapi")]
lib LibWDSCLIENTAPI
  fun WdsCliCancelTransfer = WdsCliCancelTransfer(
    hTransfer : Void*   # HANDLE
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef WdsCliCancelTransferNative = Int32 Function(Pointer<Void>);
typedef WdsCliCancelTransferDart = int Function(Pointer<Void>);
final WdsCliCancelTransfer = DynamicLibrary.open('WDSCLIENTAPI.dll')
    .lookupFunction<WdsCliCancelTransferNative, WdsCliCancelTransferDart>('WdsCliCancelTransfer');
// hTransfer : HANDLE -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function WdsCliCancelTransfer(
  hTransfer: THandle   // HANDLE
): Integer; stdcall;
  external 'WDSCLIENTAPI.dll' name 'WdsCliCancelTransfer';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "WdsCliCancelTransfer"
  c_WdsCliCancelTransfer :: Ptr () -> IO Int32
-- hTransfer : HANDLE -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let wdsclicanceltransfer =
  foreign "WdsCliCancelTransfer"
    ((ptr void) @-> returning int32_t)
(* hTransfer : HANDLE -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library wdsclientapi (t "WDSCLIENTAPI.dll"))
(cffi:use-foreign-library wdsclientapi)

(cffi:defcfun ("WdsCliCancelTransfer" wds-cli-cancel-transfer :convention :stdcall) :int32
  (h-transfer :pointer))   ; HANDLE
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $WdsCliCancelTransfer = Win32::API::More->new('WDSCLIENTAPI',
    'int WdsCliCancelTransfer(HANDLE hTransfer)');
# my $ret = $WdsCliCancelTransfer->Call($hTransfer);
# hTransfer : HANDLE -> HANDLE
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。