RpcCancelThread
関数シグネチャ
// RPCRT4.dll
#include <windows.h>
RPC_STATUS RpcCancelThread(
void* Thread
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| Thread | void* | in | キャンセルするスレッドのハンドル。 |
戻り値の型: RPC_STATUS
公式ドキュメント
RpcCancelThread 関数はスレッドをキャンセルします。非同期 RPC 呼び出しのキャンセルに RpcCancelThread 関数を使用しないでください。非同期 RPC 呼び出しをキャンセルするには、代わりに RpcAsyncCancelCall 関数を使用します。
戻り値
| 値 | 意味 |
|---|---|
| 呼び出しは成功しました。 | |
| スレッドハンドルに特権がありません。この関数が正しく実行されるには、スレッドハンドルに THREAD_SET_CONTEXT が適切に設定されている必要があります。 | |
| MS-DOS または Windows 3.x のクライアントから呼び出されました。 |
解説(Remarks)
RpcCancelThread 関数を使用すると、あるクライアントスレッドから、別のクライアントスレッドで進行中の RPC をキャンセルできます。この関数が呼び出されると、サーバーのランタイムにキャンセル操作が通知されます。サーバースタブは RpcTestCancel を呼び出すことで、呼び出しがキャンセルされたかどうかを判断できます。呼び出しがキャンセルされている場合、サーバースタブは後始末を行ってクライアントに制御を返す必要があります。
RpcCancelThread 関数は、静的コールバックを発行した呼び出しのキャンセルには使用できません。IDL ファイル内で [callback] 属性を指定して宣言された関数を呼び出す可能性のあるリモートプロシージャ呼び出しは、キャンセルしないでください。
既定では、クライアントはキャンセル後にサーバーが制御を返すまで無期限に待機します。この時間を短縮するには、 RpcMgmtSetCancelTimeout を呼び出し、応答を待機する秒数を指定します。この時間内にサーバーが制御を返さない場合、呼び出しはクライアント側で RPC_S_CALL_FAILED 例外により失敗します。サーバースタブは実行を続行します。
名前付きパイプのプロトコル ncacn_np を使用している場合は、有限のタイムアウトを指定する必要があります。
RpcCancelThread は、任意のコネクション型プロトコル (ncacn_*) と、ncadg_mq および ncalrpc を除く任意のデータグラム型プロトコルで使用できます。
メモ Windows XP/2000 では、RpcCancelThread 関数は ncacn_http で使用できません。RpcCancelThread 関数は、Windows Server 2003 以降のオペレーティングシステム、および Windows XP Service Pack 1 (SP1) 以降で ncacn_http をサポートします。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// RPCRT4.dll
#include <windows.h>
RPC_STATUS RpcCancelThread(
void* Thread
);[DllImport("RPCRT4.dll", ExactSpelling = true)]
static extern int RpcCancelThread(
IntPtr Thread // void*
);<DllImport("RPCRT4.dll", ExactSpelling:=True)>
Public Shared Function RpcCancelThread(
Thread As IntPtr ' void*
) As Integer
End Function' Thread : void*
Declare PtrSafe Function RpcCancelThread Lib "rpcrt4" ( _
ByVal Thread As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
RpcCancelThread = ctypes.windll.rpcrt4.RpcCancelThread
RpcCancelThread.restype = ctypes.c_int
RpcCancelThread.argtypes = [
ctypes.POINTER(None), # Thread : void*
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('RPCRT4.dll')
RpcCancelThread = Fiddle::Function.new(
lib['RpcCancelThread'],
[
Fiddle::TYPE_VOIDP, # Thread : void*
],
Fiddle::TYPE_INT)#[link(name = "rpcrt4")]
extern "system" {
fn RpcCancelThread(
Thread: *mut () // void*
) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("RPCRT4.dll")]
public static extern int RpcCancelThread(IntPtr Thread);
"@
$api = Add-Type -MemberDefinition $sig -Name 'RPCRT4_RpcCancelThread' -Namespace Win32 -PassThru
# $api::RpcCancelThread(Thread)#uselib "RPCRT4.dll"
#func global RpcCancelThread "RpcCancelThread" sptr
; RpcCancelThread Thread ; 戻り値は stat
; Thread : void* -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "RPCRT4.dll"
#cfunc global RpcCancelThread "RpcCancelThread" sptr
; res = RpcCancelThread(Thread)
; Thread : void* -> "sptr"; RPC_STATUS RpcCancelThread(void* Thread)
#uselib "RPCRT4.dll"
#cfunc global RpcCancelThread "RpcCancelThread" intptr
; res = RpcCancelThread(Thread)
; Thread : void* -> "intptr"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
rpcrt4 = windows.NewLazySystemDLL("RPCRT4.dll")
procRpcCancelThread = rpcrt4.NewProc("RpcCancelThread")
)
// Thread (void*)
r1, _, err := procRpcCancelThread.Call(
uintptr(Thread),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // RPC_STATUSfunction RpcCancelThread(
Thread: Pointer // void*
): Integer; stdcall;
external 'RPCRT4.dll' name 'RpcCancelThread';result := DllCall("RPCRT4\RpcCancelThread"
, "Ptr", Thread ; void*
, "Int") ; return: RPC_STATUS●RpcCancelThread(Thread) = DLL("RPCRT4.dll", "int RpcCancelThread(void*)")
# 呼び出し: RpcCancelThread(Thread)
# Thread : void* -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "rpcrt4" fn RpcCancelThread(
Thread: ?*anyopaque // void*
) callconv(std.os.windows.WINAPI) i32;proc RpcCancelThread(
Thread: pointer # void*
): int32 {.importc: "RpcCancelThread", stdcall, dynlib: "RPCRT4.dll".}pragma(lib, "rpcrt4");
extern(Windows)
int RpcCancelThread(
void* Thread // void*
);ccall((:RpcCancelThread, "RPCRT4.dll"), stdcall, Int32,
(Ptr{Cvoid},),
Thread)
# Thread : void* -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
int32_t RpcCancelThread(
void* Thread);
]]
local rpcrt4 = ffi.load("rpcrt4")
-- rpcrt4.RpcCancelThread(Thread)
-- Thread : void*
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('RPCRT4.dll');
const RpcCancelThread = lib.func('__stdcall', 'RpcCancelThread', 'int32_t', ['void *']);
// RpcCancelThread(Thread)
// Thread : void* -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("RPCRT4.dll", {
RpcCancelThread: { parameters: ["pointer"], result: "i32" },
});
// lib.symbols.RpcCancelThread(Thread)
// Thread : void* -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t RpcCancelThread(
void* Thread);
C, "RPCRT4.dll");
// $ffi->RpcCancelThread(Thread);
// Thread : void*
// 構造体/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 Rpcrt4 extends StdCallLibrary {
Rpcrt4 INSTANCE = Native.load("rpcrt4", Rpcrt4.class);
int RpcCancelThread(
Pointer Thread // void*
);
}@[Link("rpcrt4")]
lib LibRPCRT4
fun RpcCancelThread = RpcCancelThread(
Thread : Void* # void*
) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef RpcCancelThreadNative = Int32 Function(Pointer<Void>);
typedef RpcCancelThreadDart = int Function(Pointer<Void>);
final RpcCancelThread = DynamicLibrary.open('RPCRT4.dll')
.lookupFunction<RpcCancelThreadNative, RpcCancelThreadDart>('RpcCancelThread');
// Thread : void* -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function RpcCancelThread(
Thread: Pointer // void*
): Integer; stdcall;
external 'RPCRT4.dll' name 'RpcCancelThread';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "RpcCancelThread"
c_RpcCancelThread :: Ptr () -> IO Int32
-- Thread : void* -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let rpccancelthread =
foreign "RpcCancelThread"
((ptr void) @-> returning int32_t)
(* Thread : void* -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library rpcrt4 (t "RPCRT4.dll"))
(cffi:use-foreign-library rpcrt4)
(cffi:defcfun ("RpcCancelThread" rpc-cancel-thread :convention :stdcall) :int32
(thread :pointer)) ; void*
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $RpcCancelThread = Win32::API::More->new('RPCRT4',
'int RpcCancelThread(LPVOID Thread)');
# my $ret = $RpcCancelThread->Call($Thread);
# Thread : void* -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
- f RpcCancelThreadEx — タイムアウトを指定して、指定スレッドのRPC呼び出しをキャンセルする。
- f RpcTestCancel — 現在のスレッドのRPC呼び出しがキャンセルされたかをテストする。