CancelSynchronousIo
関数指定スレッドの同期I/O操作をキャンセルする。
シグネチャ
// KERNEL32.dll
#include <windows.h>
BOOL CancelSynchronousIo(
HANDLE hThread
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| hThread | HANDLE | in | スレッドへのハンドル。 |
戻り値の型: BOOL
公式ドキュメント
指定したスレッドが発行した、保留中の同期 I/O 操作をキャンセル済みとしてマークします。
戻り値
関数が成功した場合、戻り値は 0 以外の値です。
関数が失敗した場合、戻り値は 0 (ゼロ) です。拡張エラー情報を取得するには、 GetLastError 関数を呼び出します。
キャンセルする要求が見つからない場合、戻り値は 0 (ゼロ) となり、 GetLastError は ERROR_NOT_FOUND を返します。
解説(Remarks)
呼び出し元には THREAD_TERMINATE アクセス権が必要です。
指定したスレッドに対して進行中の保留 I/O 操作がある場合、 CancelSynchronousIo 関数はそれらをキャンセル対象としてマークします。ほとんどの種類の操作は即座にキャンセルできますが、 操作によっては、実際にキャンセルされて呼び出し元に通知されるまでの間、完了に向けて処理が継続される場合があります。 CancelSynchronousIo 関数は、すべてのキャンセル対象操作の完了を待ちません。詳細については、 Canceling Pending I/O Operations を参照してください。
キャンセルされる操作は、3 つのステータスのいずれかで完了します。完了状態を判断するには、完了ステータスを確認する必要があります。 3 つのステータスは次のとおりです。
- 操作が正常に完了した。 これは、操作がキャンセルされた場合でも発生する可能性があります。 キャンセル要求が操作をキャンセルするのに間に合わなかった可能性があるためです。
- 操作がキャンセルされた。 GetLastError 関数は ERROR_OPERATION_ABORTED を返します。
- 操作が別のエラーで失敗した。 GetLastError 関数は該当するエラー コードを返します。
| テクノロジ | サポート |
|---|---|
| Server Message Block (SMB) 3.0 プロトコル | はい |
| SMB 3.0 Transparent Failover (TFO) | はい |
| SMB 3.0 with Scale-out File Shares (SO) | はい |
| Cluster Shared Volume File System (CsvFS) | はい |
| Resilient File System (ReFS) | はい |
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// KERNEL32.dll
#include <windows.h>
BOOL CancelSynchronousIo(
HANDLE hThread
);[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool CancelSynchronousIo(
IntPtr hThread // HANDLE
);<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CancelSynchronousIo(
hThread As IntPtr ' HANDLE
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function' hThread : HANDLE
Declare PtrSafe Function CancelSynchronousIo Lib "kernel32" ( _
ByVal hThread As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
CancelSynchronousIo = ctypes.windll.kernel32.CancelSynchronousIo
CancelSynchronousIo.restype = wintypes.BOOL
CancelSynchronousIo.argtypes = [
wintypes.HANDLE, # hThread : HANDLE
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('KERNEL32.dll')
CancelSynchronousIo = Fiddle::Function.new(
lib['CancelSynchronousIo'],
[
Fiddle::TYPE_VOIDP, # hThread : HANDLE
],
Fiddle::TYPE_INT)#[link(name = "kernel32")]
extern "system" {
fn CancelSynchronousIo(
hThread: *mut core::ffi::c_void // HANDLE
) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true)]
public static extern bool CancelSynchronousIo(IntPtr hThread);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_CancelSynchronousIo' -Namespace Win32 -PassThru
# $api::CancelSynchronousIo(hThread)#uselib "KERNEL32.dll"
#func global CancelSynchronousIo "CancelSynchronousIo" sptr
; CancelSynchronousIo hThread ; 戻り値は stat
; hThread : HANDLE -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "KERNEL32.dll"
#cfunc global CancelSynchronousIo "CancelSynchronousIo" sptr
; res = CancelSynchronousIo(hThread)
; hThread : HANDLE -> "sptr"; BOOL CancelSynchronousIo(HANDLE hThread)
#uselib "KERNEL32.dll"
#cfunc global CancelSynchronousIo "CancelSynchronousIo" intptr
; res = CancelSynchronousIo(hThread)
; hThread : HANDLE -> "intptr"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
procCancelSynchronousIo = kernel32.NewProc("CancelSynchronousIo")
)
// hThread (HANDLE)
r1, _, err := procCancelSynchronousIo.Call(
uintptr(hThread),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // BOOLfunction CancelSynchronousIo(
hThread: THandle // HANDLE
): BOOL; stdcall;
external 'KERNEL32.dll' name 'CancelSynchronousIo';result := DllCall("KERNEL32\CancelSynchronousIo"
, "Ptr", hThread ; HANDLE
, "Int") ; return: BOOL●CancelSynchronousIo(hThread) = DLL("KERNEL32.dll", "bool CancelSynchronousIo(void*)")
# 呼び出し: CancelSynchronousIo(hThread)
# hThread : HANDLE -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "kernel32" fn CancelSynchronousIo(
hThread: ?*anyopaque // HANDLE
) callconv(std.os.windows.WINAPI) i32;proc CancelSynchronousIo(
hThread: pointer # HANDLE
): int32 {.importc: "CancelSynchronousIo", stdcall, dynlib: "KERNEL32.dll".}pragma(lib, "kernel32");
extern(Windows)
int CancelSynchronousIo(
void* hThread // HANDLE
);ccall((:CancelSynchronousIo, "KERNEL32.dll"), stdcall, Int32,
(Ptr{Cvoid},),
hThread)
# hThread : HANDLE -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
int32_t CancelSynchronousIo(
void* hThread);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.CancelSynchronousIo(hThread)
-- hThread : HANDLE
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const CancelSynchronousIo = lib.func('__stdcall', 'CancelSynchronousIo', 'int32_t', ['void *']);
// CancelSynchronousIo(hThread)
// hThread : HANDLE -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("KERNEL32.dll", {
CancelSynchronousIo: { parameters: ["pointer"], result: "i32" },
});
// lib.symbols.CancelSynchronousIo(hThread)
// hThread : HANDLE -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t CancelSynchronousIo(
void* hThread);
C, "KERNEL32.dll");
// $ffi->CancelSynchronousIo(hThread);
// hThread : 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 Kernel32 extends StdCallLibrary {
Kernel32 INSTANCE = Native.load("kernel32", Kernel32.class);
boolean CancelSynchronousIo(
Pointer hThread // HANDLE
);
}@[Link("kernel32")]
lib LibKERNEL32
fun CancelSynchronousIo = CancelSynchronousIo(
hThread : 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 CancelSynchronousIoNative = Int32 Function(Pointer<Void>);
typedef CancelSynchronousIoDart = int Function(Pointer<Void>);
final CancelSynchronousIo = DynamicLibrary.open('KERNEL32.dll')
.lookupFunction<CancelSynchronousIoNative, CancelSynchronousIoDart>('CancelSynchronousIo');
// hThread : HANDLE -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function CancelSynchronousIo(
hThread: THandle // HANDLE
): BOOL; stdcall;
external 'KERNEL32.dll' name 'CancelSynchronousIo';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "CancelSynchronousIo"
c_CancelSynchronousIo :: Ptr () -> IO CInt
-- hThread : HANDLE -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let cancelsynchronousio =
foreign "CancelSynchronousIo"
((ptr void) @-> returning int32_t)
(* hThread : HANDLE -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)
(cffi:defcfun ("CancelSynchronousIo" cancel-synchronous-io :convention :stdcall) :int32
(h-thread :pointer)) ; HANDLE
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $CancelSynchronousIo = Win32::API::More->new('KERNEL32',
'BOOL CancelSynchronousIo(HANDLE hThread)');
# my $ret = $CancelSynchronousIo->Call($hThread);
# hThread : HANDLE -> HANDLE
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。