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

RtwqCancelWorkItem

関数
キーで指定したスケジュール済み作業項目をキャンセルする。
DLLRTWorkQ.dll呼出規約winapi対応OSWindows 8.1 以降

シグネチャ

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

HRESULT RtwqCancelWorkItem(
    ULONGLONG Key
);

パラメーター

名前方向説明
KeyULONGLONGinRtwqScheduleWorkItemkey パラメーターで受け取ったキーです。

戻り値の型: HRESULT

公式ドキュメント

RtwqScheduleWorkItem でスケジュールされた非同期操作のキャンセルを試みます。

戻り値

この関数が成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

解説(Remarks)

作業項目は非同期であるため、RtwqCancelWorkItem を呼び出した後でも作業項目のコールバックが呼び出される可能性があります。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

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

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

RtwqCancelWorkItem = ctypes.windll.rtworkq.RtwqCancelWorkItem
RtwqCancelWorkItem.restype = ctypes.c_int
RtwqCancelWorkItem.argtypes = [
    ctypes.c_ulonglong,  # Key : ULONGLONG
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('RTWorkQ.dll')
RtwqCancelWorkItem = Fiddle::Function.new(
  lib['RtwqCancelWorkItem'],
  [
    -Fiddle::TYPE_LONG_LONG,  # Key : ULONGLONG
  ],
  Fiddle::TYPE_INT)
#[link(name = "rtworkq")]
extern "system" {
    fn RtwqCancelWorkItem(
        Key: u64  // ULONGLONG
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("RTWorkQ.dll")]
public static extern int RtwqCancelWorkItem(ulong Key);
"@
$api = Add-Type -MemberDefinition $sig -Name 'RTWorkQ_RtwqCancelWorkItem' -Namespace Win32 -PassThru
# $api::RtwqCancelWorkItem(Key)
#uselib "RTWorkQ.dll"
#func global RtwqCancelWorkItem "RtwqCancelWorkItem" sptr
; RtwqCancelWorkItem Key   ; 戻り値は stat
; Key : ULONGLONG -> "sptr"
; ※HSP3.7は int64 引数(64bit値渡し)に非対応です。
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "RTWorkQ.dll"
#cfunc global RtwqCancelWorkItem "RtwqCancelWorkItem" int64
; res = RtwqCancelWorkItem(Key)
; Key : ULONGLONG -> "int64"
; ※int64 引数の DLL 値渡しは x64 ランタイム(hsp3_64)のみ対応(x86 は未対応)。
; HRESULT RtwqCancelWorkItem(ULONGLONG Key)
#uselib "RTWorkQ.dll"
#cfunc global RtwqCancelWorkItem "RtwqCancelWorkItem" int64
; res = RtwqCancelWorkItem(Key)
; Key : ULONGLONG -> "int64"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	rtworkq = windows.NewLazySystemDLL("RTWorkQ.dll")
	procRtwqCancelWorkItem = rtworkq.NewProc("RtwqCancelWorkItem")
)

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

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

typedef RtwqCancelWorkItemNative = Int32 Function(Uint64);
typedef RtwqCancelWorkItemDart = int Function(int);
final RtwqCancelWorkItem = DynamicLibrary.open('RTWorkQ.dll')
    .lookupFunction<RtwqCancelWorkItemNative, RtwqCancelWorkItemDart>('RtwqCancelWorkItem');
// Key : ULONGLONG -> Uint64
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function RtwqCancelWorkItem(
  Key: UInt64   // ULONGLONG
): Integer; stdcall;
  external 'RTWorkQ.dll' name 'RtwqCancelWorkItem';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let rtwqcancelworkitem =
  foreign "RtwqCancelWorkItem"
    (uint64_t @-> returning int32_t)
(* Key : ULONGLONG -> uint64_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library rtworkq (t "RTWorkQ.dll"))
(cffi:use-foreign-library rtworkq)

(cffi:defcfun ("RtwqCancelWorkItem" rtwq-cancel-work-item :convention :stdcall) :int32
  (key :uint64))   ; ULONGLONG
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $RtwqCancelWorkItem = Win32::API::More->new('RTWorkQ',
    'int RtwqCancelWorkItem(UINT64 Key)');
# my $ret = $RtwqCancelWorkItem->Call($Key);
# Key : ULONGLONG -> UINT64
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。