Win32 API 日本語リファレンス
ホームNetworking.WindowsWebServices › WsRegisterOperationForCancel

WsRegisterOperationForCancel

関数
操作のキャンセルコールバックを登録する。
DLLwebservices.dll呼出規約winapi対応OSWindows 7 以降

シグネチャ

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

HRESULT WsRegisterOperationForCancel(
    const WS_OPERATION_CONTEXT* context,
    WS_OPERATION_CANCEL_CALLBACK cancelCallback,
    WS_OPERATION_FREE_STATE_CALLBACK freestateCallback,   // optional
    void* userState,   // optional
    WS_ERROR* error   // optional
);

パラメーター

名前方向説明
contextWS_OPERATION_CONTEXT*in操作のWS_OPERATION_CONTEXT。キャンセル対象の操作を識別する。
cancelCallbackWS_OPERATION_CANCEL_CALLBACKin操作キャンセル時に呼ばれるWS_OPERATION_CANCEL_CALLBACK。
freestateCallbackWS_OPERATION_FREE_STATE_CALLBACKinoptionalユーザー状態解放時に呼ばれるWS_OPERATION_FREE_STATE_CALLBACK。NULL可。
userStatevoid*inoptionalコールバックに渡すユーザー状態ポインタ。NULL可。
errorWS_ERROR*inoptional詳細なエラー情報を格納するWS_ERRORオブジェクト。NULL可。

戻り値の型: HRESULT

各言語での呼び出し定義

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

HRESULT WsRegisterOperationForCancel(
    const WS_OPERATION_CONTEXT* context,
    WS_OPERATION_CANCEL_CALLBACK cancelCallback,
    WS_OPERATION_FREE_STATE_CALLBACK freestateCallback,   // optional
    void* userState,   // optional
    WS_ERROR* error   // optional
);
[DllImport("webservices.dll", ExactSpelling = true)]
static extern int WsRegisterOperationForCancel(
    ref IntPtr context,   // WS_OPERATION_CONTEXT*
    IntPtr cancelCallback,   // WS_OPERATION_CANCEL_CALLBACK
    IntPtr freestateCallback,   // WS_OPERATION_FREE_STATE_CALLBACK optional
    IntPtr userState,   // void* optional
    IntPtr error   // WS_ERROR* optional
);
<DllImport("webservices.dll", ExactSpelling:=True)>
Public Shared Function WsRegisterOperationForCancel(
    ByRef context As IntPtr,   ' WS_OPERATION_CONTEXT*
    cancelCallback As IntPtr,   ' WS_OPERATION_CANCEL_CALLBACK
    freestateCallback As IntPtr,   ' WS_OPERATION_FREE_STATE_CALLBACK optional
    userState As IntPtr,   ' void* optional
    [error] As IntPtr   ' WS_ERROR* optional
) As Integer
End Function
' context : WS_OPERATION_CONTEXT*
' cancelCallback : WS_OPERATION_CANCEL_CALLBACK
' freestateCallback : WS_OPERATION_FREE_STATE_CALLBACK optional
' userState : void* optional
' error : WS_ERROR* optional
Declare PtrSafe Function WsRegisterOperationForCancel Lib "webservices" ( _
    ByRef context As LongPtr, _
    ByVal cancelCallback As LongPtr, _
    ByVal freestateCallback As LongPtr, _
    ByVal userState As LongPtr, _
    ByVal error As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

WsRegisterOperationForCancel = ctypes.windll.webservices.WsRegisterOperationForCancel
WsRegisterOperationForCancel.restype = ctypes.c_int
WsRegisterOperationForCancel.argtypes = [
    ctypes.c_void_p,  # context : WS_OPERATION_CONTEXT*
    ctypes.c_void_p,  # cancelCallback : WS_OPERATION_CANCEL_CALLBACK
    ctypes.c_void_p,  # freestateCallback : WS_OPERATION_FREE_STATE_CALLBACK optional
    ctypes.POINTER(None),  # userState : void* optional
    ctypes.c_void_p,  # error : WS_ERROR* optional
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('webservices.dll')
WsRegisterOperationForCancel = Fiddle::Function.new(
  lib['WsRegisterOperationForCancel'],
  [
    Fiddle::TYPE_VOIDP,  # context : WS_OPERATION_CONTEXT*
    Fiddle::TYPE_VOIDP,  # cancelCallback : WS_OPERATION_CANCEL_CALLBACK
    Fiddle::TYPE_VOIDP,  # freestateCallback : WS_OPERATION_FREE_STATE_CALLBACK optional
    Fiddle::TYPE_VOIDP,  # userState : void* optional
    Fiddle::TYPE_VOIDP,  # error : WS_ERROR* optional
  ],
  Fiddle::TYPE_INT)
#[link(name = "webservices")]
extern "system" {
    fn WsRegisterOperationForCancel(
        context: *const isize,  // WS_OPERATION_CONTEXT*
        cancelCallback: *const core::ffi::c_void,  // WS_OPERATION_CANCEL_CALLBACK
        freestateCallback: *const core::ffi::c_void,  // WS_OPERATION_FREE_STATE_CALLBACK optional
        userState: *mut (),  // void* optional
        error: *mut isize  // WS_ERROR* optional
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("webservices.dll")]
public static extern int WsRegisterOperationForCancel(ref IntPtr context, IntPtr cancelCallback, IntPtr freestateCallback, IntPtr userState, IntPtr error);
"@
$api = Add-Type -MemberDefinition $sig -Name 'webservices_WsRegisterOperationForCancel' -Namespace Win32 -PassThru
# $api::WsRegisterOperationForCancel(context, cancelCallback, freestateCallback, userState, error)
#uselib "webservices.dll"
#func global WsRegisterOperationForCancel "WsRegisterOperationForCancel" sptr, sptr, sptr, sptr, sptr
; WsRegisterOperationForCancel varptr(context), cancelCallback, freestateCallback, userState, varptr(error)   ; 戻り値は stat
; context : WS_OPERATION_CONTEXT* -> "sptr"
; cancelCallback : WS_OPERATION_CANCEL_CALLBACK -> "sptr"
; freestateCallback : WS_OPERATION_FREE_STATE_CALLBACK optional -> "sptr"
; userState : void* optional -> "sptr"
; error : WS_ERROR* optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "webservices.dll"
#cfunc global WsRegisterOperationForCancel "WsRegisterOperationForCancel" var, sptr, sptr, sptr, var
; res = WsRegisterOperationForCancel(context, cancelCallback, freestateCallback, userState, error)
; context : WS_OPERATION_CONTEXT* -> "var"
; cancelCallback : WS_OPERATION_CANCEL_CALLBACK -> "sptr"
; freestateCallback : WS_OPERATION_FREE_STATE_CALLBACK optional -> "sptr"
; userState : void* optional -> "sptr"
; error : WS_ERROR* optional -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; HRESULT WsRegisterOperationForCancel(WS_OPERATION_CONTEXT* context, WS_OPERATION_CANCEL_CALLBACK cancelCallback, WS_OPERATION_FREE_STATE_CALLBACK freestateCallback, void* userState, WS_ERROR* error)
#uselib "webservices.dll"
#cfunc global WsRegisterOperationForCancel "WsRegisterOperationForCancel" var, intptr, intptr, intptr, var
; res = WsRegisterOperationForCancel(context, cancelCallback, freestateCallback, userState, error)
; context : WS_OPERATION_CONTEXT* -> "var"
; cancelCallback : WS_OPERATION_CANCEL_CALLBACK -> "intptr"
; freestateCallback : WS_OPERATION_FREE_STATE_CALLBACK optional -> "intptr"
; userState : void* optional -> "intptr"
; error : WS_ERROR* optional -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	webservices = windows.NewLazySystemDLL("webservices.dll")
	procWsRegisterOperationForCancel = webservices.NewProc("WsRegisterOperationForCancel")
)

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

extern "webservices" fn WsRegisterOperationForCancel(
    context: [*c]isize, // WS_OPERATION_CONTEXT*
    cancelCallback: ?*anyopaque, // WS_OPERATION_CANCEL_CALLBACK
    freestateCallback: ?*anyopaque, // WS_OPERATION_FREE_STATE_CALLBACK optional
    userState: ?*anyopaque, // void* optional
    error: [*c]isize // WS_ERROR* optional
) callconv(std.os.windows.WINAPI) i32;
proc WsRegisterOperationForCancel(
    context: ptr int,  # WS_OPERATION_CONTEXT*
    cancelCallback: pointer,  # WS_OPERATION_CANCEL_CALLBACK
    freestateCallback: pointer,  # WS_OPERATION_FREE_STATE_CALLBACK optional
    userState: pointer,  # void* optional
    error: ptr int  # WS_ERROR* optional
): int32 {.importc: "WsRegisterOperationForCancel", stdcall, dynlib: "webservices.dll".}
pragma(lib, "webservices");
extern(Windows)
int WsRegisterOperationForCancel(
    ptrdiff_t* context,   // WS_OPERATION_CONTEXT*
    void* cancelCallback,   // WS_OPERATION_CANCEL_CALLBACK
    void* freestateCallback,   // WS_OPERATION_FREE_STATE_CALLBACK optional
    void* userState,   // void* optional
    ptrdiff_t* error   // WS_ERROR* optional
);
ccall((:WsRegisterOperationForCancel, "webservices.dll"), stdcall, Int32,
      (Ptr{Int}, Ptr{Cvoid}, Ptr{Cvoid}, Ptr{Cvoid}, Ptr{Int}),
      context, cancelCallback, freestateCallback, userState, error)
# context : WS_OPERATION_CONTEXT* -> Ptr{Int}
# cancelCallback : WS_OPERATION_CANCEL_CALLBACK -> Ptr{Cvoid}
# freestateCallback : WS_OPERATION_FREE_STATE_CALLBACK optional -> Ptr{Cvoid}
# userState : void* optional -> Ptr{Cvoid}
# error : WS_ERROR* optional -> Ptr{Int}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t WsRegisterOperationForCancel(
    intptr_t* context,
    void* cancelCallback,
    void* freestateCallback,
    void* userState,
    intptr_t* error);
]]
local webservices = ffi.load("webservices")
-- webservices.WsRegisterOperationForCancel(context, cancelCallback, freestateCallback, userState, error)
-- context : WS_OPERATION_CONTEXT*
-- cancelCallback : WS_OPERATION_CANCEL_CALLBACK
-- freestateCallback : WS_OPERATION_FREE_STATE_CALLBACK optional
-- userState : void* optional
-- error : WS_ERROR* optional
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('webservices.dll');
const WsRegisterOperationForCancel = lib.func('__stdcall', 'WsRegisterOperationForCancel', 'int32_t', ['intptr_t *', 'void *', 'void *', 'void *', 'intptr_t *']);
// WsRegisterOperationForCancel(context, cancelCallback, freestateCallback, userState, error)
// context : WS_OPERATION_CONTEXT* -> 'intptr_t *'
// cancelCallback : WS_OPERATION_CANCEL_CALLBACK -> 'void *'
// freestateCallback : WS_OPERATION_FREE_STATE_CALLBACK optional -> 'void *'
// userState : void* optional -> 'void *'
// error : WS_ERROR* optional -> 'intptr_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
// コールバック(関数ポインタ)は koffi.proto/koffi.register で型を定義して渡す(素の void* では JS 関数を渡せない)。
const lib = Deno.dlopen("webservices.dll", {
  WsRegisterOperationForCancel: { parameters: ["pointer", "pointer", "pointer", "pointer", "pointer"], result: "i32" },
});
// lib.symbols.WsRegisterOperationForCancel(context, cancelCallback, freestateCallback, userState, error)
// context : WS_OPERATION_CONTEXT* -> "pointer"
// cancelCallback : WS_OPERATION_CANCEL_CALLBACK -> "pointer"
// freestateCallback : WS_OPERATION_FREE_STATE_CALLBACK optional -> "pointer"
// userState : void* optional -> "pointer"
// error : WS_ERROR* optional -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t WsRegisterOperationForCancel(
    intptr_t* context,
    void* cancelCallback,
    void* freestateCallback,
    void* userState,
    intptr_t* error);
C, "webservices.dll");
// $ffi->WsRegisterOperationForCancel(context, cancelCallback, freestateCallback, userState, error);
// context : WS_OPERATION_CONTEXT*
// cancelCallback : WS_OPERATION_CANCEL_CALLBACK
// freestateCallback : WS_OPERATION_FREE_STATE_CALLBACK optional
// userState : void* optional
// error : WS_ERROR* optional
// 構造体/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 Webservices extends StdCallLibrary {
    Webservices INSTANCE = Native.load("webservices", Webservices.class);
    int WsRegisterOperationForCancel(
        LongByReference context,   // WS_OPERATION_CONTEXT*
        Callback cancelCallback,   // WS_OPERATION_CANCEL_CALLBACK
        Callback freestateCallback,   // WS_OPERATION_FREE_STATE_CALLBACK optional
        Pointer userState,   // void* optional
        LongByReference error   // WS_ERROR* optional
    );
}
@[Link("webservices")]
lib Libwebservices
  fun WsRegisterOperationForCancel = WsRegisterOperationForCancel(
    context : LibC::SSizeT*,   # WS_OPERATION_CONTEXT*
    cancelCallback : Void*,   # WS_OPERATION_CANCEL_CALLBACK
    freestateCallback : Void*,   # WS_OPERATION_FREE_STATE_CALLBACK optional
    userState : Void*,   # void* optional
    error : LibC::SSizeT*   # WS_ERROR* optional
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef WsRegisterOperationForCancelNative = Int32 Function(Pointer<IntPtr>, Pointer<Void>, Pointer<Void>, Pointer<Void>, Pointer<IntPtr>);
typedef WsRegisterOperationForCancelDart = int Function(Pointer<IntPtr>, Pointer<Void>, Pointer<Void>, Pointer<Void>, Pointer<IntPtr>);
final WsRegisterOperationForCancel = DynamicLibrary.open('webservices.dll')
    .lookupFunction<WsRegisterOperationForCancelNative, WsRegisterOperationForCancelDart>('WsRegisterOperationForCancel');
// context : WS_OPERATION_CONTEXT* -> Pointer<IntPtr>
// cancelCallback : WS_OPERATION_CANCEL_CALLBACK -> Pointer<Void>
// freestateCallback : WS_OPERATION_FREE_STATE_CALLBACK optional -> Pointer<Void>
// userState : void* optional -> Pointer<Void>
// error : WS_ERROR* optional -> Pointer<IntPtr>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function WsRegisterOperationForCancel(
  context: Pointer;   // WS_OPERATION_CONTEXT*
  cancelCallback: Pointer;   // WS_OPERATION_CANCEL_CALLBACK
  freestateCallback: Pointer;   // WS_OPERATION_FREE_STATE_CALLBACK optional
  userState: Pointer;   // void* optional
  error: Pointer   // WS_ERROR* optional
): Integer; stdcall;
  external 'webservices.dll' name 'WsRegisterOperationForCancel';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "WsRegisterOperationForCancel"
  c_WsRegisterOperationForCancel :: Ptr CIntPtr -> Ptr () -> Ptr () -> Ptr () -> Ptr CIntPtr -> IO Int32
-- context : WS_OPERATION_CONTEXT* -> Ptr CIntPtr
-- cancelCallback : WS_OPERATION_CANCEL_CALLBACK -> Ptr ()
-- freestateCallback : WS_OPERATION_FREE_STATE_CALLBACK optional -> Ptr ()
-- userState : void* optional -> Ptr ()
-- error : WS_ERROR* optional -> Ptr CIntPtr
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let wsregisteroperationforcancel =
  foreign "WsRegisterOperationForCancel"
    ((ptr intptr_t) @-> (ptr void) @-> (ptr void) @-> (ptr void) @-> (ptr intptr_t) @-> returning int32_t)
(* context : WS_OPERATION_CONTEXT* -> (ptr intptr_t) *)
(* cancelCallback : WS_OPERATION_CANCEL_CALLBACK -> (ptr void) *)
(* freestateCallback : WS_OPERATION_FREE_STATE_CALLBACK optional -> (ptr void) *)
(* userState : void* optional -> (ptr void) *)
(* error : WS_ERROR* optional -> (ptr intptr_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library webservices (t "webservices.dll"))
(cffi:use-foreign-library webservices)

(cffi:defcfun ("WsRegisterOperationForCancel" ws-register-operation-for-cancel :convention :stdcall) :int32
  (context :pointer)   ; WS_OPERATION_CONTEXT*
  (cancel-callback :pointer)   ; WS_OPERATION_CANCEL_CALLBACK
  (freestate-callback :pointer)   ; WS_OPERATION_FREE_STATE_CALLBACK optional
  (user-state :pointer)   ; void* optional
  (error :pointer))   ; WS_ERROR* optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $WsRegisterOperationForCancel = Win32::API::More->new('webservices',
    'int WsRegisterOperationForCancel(LPVOID context, LPVOID cancelCallback, LPVOID freestateCallback, LPVOID userState, LPVOID error)');
# my $ret = $WsRegisterOperationForCancel->Call($context, $cancelCallback, $freestateCallback, $userState, $error);
# context : WS_OPERATION_CONTEXT* -> LPVOID
# cancelCallback : WS_OPERATION_CANCEL_CALLBACK -> LPVOID
# freestateCallback : WS_OPERATION_FREE_STATE_CALLBACK optional -> LPVOID
# userState : void* optional -> LPVOID
# error : WS_ERROR* optional -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# コールバック(関数ポインタ)は Perl sub を直接渡せません。Win32::API::Callback を使用してください。

関連項目

使用する型