ホーム › Networking.WinSock › WSACancelAsyncRequest
WSACancelAsyncRequest
関数進行中の非同期データベース問い合わせを取り消す。
シグネチャ
// WS2_32.dll
#include <windows.h>
INT WSACancelAsyncRequest(
HANDLE hAsyncTaskHandle
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| hAsyncTaskHandle | HANDLE | in | キャンセルする非同期操作を指定するハンドル。 |
戻り値の型: INT
公式ドキュメント
WSACancelAsyncRequest 関数 (winsock.h) は、完了していない非同期操作をキャンセルします。
戻り値
WSACancelAsyncRequest が返す値は、操作が正常にキャンセルされた場合はゼロです。それ以外の場合は SOCKET_ERROR が返され、 WSAGetLastError を呼び出すことで具体的なエラー番号を取得できます。
| エラーコード | 意味 |
|---|---|
| この関数を使用する前に、 WSAStartup の呼び出しが正常に完了している必要があります。 | |
| ネットワークサブシステムが失敗しました。 | |
| 指定された非同期タスクハンドルが無効であったことを示します。 | |
| ブロッキング型の Windows Sockets 1.1 呼び出しが進行中であるか、サービスプロバイダーがコールバック関数をまだ処理中です。 | |
| キャンセルしようとした非同期ルーチンは既に完了しています。 |
注意 アプリケーションが
WSAEINVAL と
WSAEALREADY を有意に区別できるかどうかは明確ではありません。どちらの場合も、指定されたハンドルに対応する非同期操作が進行中でないことをエラーが示すためです(自明な例外: ゼロは常に無効な非同期タスクハンドルです)。Windows Sockets の仕様では、準拠した Windows Sockets プロバイダーがこの 2 つのケースをどのように区別すべきかは規定されていません。最大限の移植性を確保するため、Windows Sockets アプリケーションはこの 2 つのエラーを同等のものとして扱うべきです。
解説(Remarks)
WSACancelAsyncRequest 関数は、 WSAAsyncGetHostByName などの WSAAsyncGetXByY 関数のいずれかによって開始された非同期操作をキャンセルするために使用します。キャンセル対象の操作は hAsyncTaskHandle パラメーターで識別されます。このパラメーターには、操作を開始した WSAAsyncGetXByY 関数が返した非同期タスクハンドルを設定する必要があります。
既存の非同期 WSAAsyncGetXByY 操作をキャンセルしようとすると、次の 2 つの理由でエラーコード WSAEALREADY が発生して失敗することがあります。1 つ目は、元の操作が既に完了しており、アプリケーションが結果のメッセージを処理済みである場合です。2 つ目は、元の操作は既に完了しているものの、結果のメッセージがまだアプリケーションのウィンドウキュー内で待機している場合です。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// WS2_32.dll
#include <windows.h>
INT WSACancelAsyncRequest(
HANDLE hAsyncTaskHandle
);[DllImport("WS2_32.dll", SetLastError = true, ExactSpelling = true)]
static extern int WSACancelAsyncRequest(
IntPtr hAsyncTaskHandle // HANDLE
);<DllImport("WS2_32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function WSACancelAsyncRequest(
hAsyncTaskHandle As IntPtr ' HANDLE
) As Integer
End Function' hAsyncTaskHandle : HANDLE
Declare PtrSafe Function WSACancelAsyncRequest Lib "ws2_32" ( _
ByVal hAsyncTaskHandle As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
WSACancelAsyncRequest = ctypes.windll.ws2_32.WSACancelAsyncRequest
WSACancelAsyncRequest.restype = ctypes.c_int
WSACancelAsyncRequest.argtypes = [
wintypes.HANDLE, # hAsyncTaskHandle : HANDLE
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('WS2_32.dll')
WSACancelAsyncRequest = Fiddle::Function.new(
lib['WSACancelAsyncRequest'],
[
Fiddle::TYPE_VOIDP, # hAsyncTaskHandle : HANDLE
],
Fiddle::TYPE_INT)#[link(name = "ws2_32")]
extern "system" {
fn WSACancelAsyncRequest(
hAsyncTaskHandle: *mut core::ffi::c_void // HANDLE
) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("WS2_32.dll", SetLastError = true)]
public static extern int WSACancelAsyncRequest(IntPtr hAsyncTaskHandle);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WS2_32_WSACancelAsyncRequest' -Namespace Win32 -PassThru
# $api::WSACancelAsyncRequest(hAsyncTaskHandle)#uselib "WS2_32.dll"
#func global WSACancelAsyncRequest "WSACancelAsyncRequest" sptr
; WSACancelAsyncRequest hAsyncTaskHandle ; 戻り値は stat
; hAsyncTaskHandle : HANDLE -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "WS2_32.dll"
#cfunc global WSACancelAsyncRequest "WSACancelAsyncRequest" sptr
; res = WSACancelAsyncRequest(hAsyncTaskHandle)
; hAsyncTaskHandle : HANDLE -> "sptr"; INT WSACancelAsyncRequest(HANDLE hAsyncTaskHandle)
#uselib "WS2_32.dll"
#cfunc global WSACancelAsyncRequest "WSACancelAsyncRequest" intptr
; res = WSACancelAsyncRequest(hAsyncTaskHandle)
; hAsyncTaskHandle : HANDLE -> "intptr"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
ws2_32 = windows.NewLazySystemDLL("WS2_32.dll")
procWSACancelAsyncRequest = ws2_32.NewProc("WSACancelAsyncRequest")
)
// hAsyncTaskHandle (HANDLE)
r1, _, err := procWSACancelAsyncRequest.Call(
uintptr(hAsyncTaskHandle),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // INTfunction WSACancelAsyncRequest(
hAsyncTaskHandle: THandle // HANDLE
): Integer; stdcall;
external 'WS2_32.dll' name 'WSACancelAsyncRequest';result := DllCall("WS2_32\WSACancelAsyncRequest"
, "Ptr", hAsyncTaskHandle ; HANDLE
, "Int") ; return: INT●WSACancelAsyncRequest(hAsyncTaskHandle) = DLL("WS2_32.dll", "int WSACancelAsyncRequest(void*)")
# 呼び出し: WSACancelAsyncRequest(hAsyncTaskHandle)
# hAsyncTaskHandle : HANDLE -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "ws2_32" fn WSACancelAsyncRequest(
hAsyncTaskHandle: ?*anyopaque // HANDLE
) callconv(std.os.windows.WINAPI) i32;proc WSACancelAsyncRequest(
hAsyncTaskHandle: pointer # HANDLE
): int32 {.importc: "WSACancelAsyncRequest", stdcall, dynlib: "WS2_32.dll".}pragma(lib, "ws2_32");
extern(Windows)
int WSACancelAsyncRequest(
void* hAsyncTaskHandle // HANDLE
);ccall((:WSACancelAsyncRequest, "WS2_32.dll"), stdcall, Int32,
(Ptr{Cvoid},),
hAsyncTaskHandle)
# hAsyncTaskHandle : HANDLE -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
int32_t WSACancelAsyncRequest(
void* hAsyncTaskHandle);
]]
local ws2_32 = ffi.load("ws2_32")
-- ws2_32.WSACancelAsyncRequest(hAsyncTaskHandle)
-- hAsyncTaskHandle : HANDLE
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('WS2_32.dll');
const WSACancelAsyncRequest = lib.func('__stdcall', 'WSACancelAsyncRequest', 'int32_t', ['void *']);
// WSACancelAsyncRequest(hAsyncTaskHandle)
// hAsyncTaskHandle : HANDLE -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("WS2_32.dll", {
WSACancelAsyncRequest: { parameters: ["pointer"], result: "i32" },
});
// lib.symbols.WSACancelAsyncRequest(hAsyncTaskHandle)
// hAsyncTaskHandle : HANDLE -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t WSACancelAsyncRequest(
void* hAsyncTaskHandle);
C, "WS2_32.dll");
// $ffi->WSACancelAsyncRequest(hAsyncTaskHandle);
// hAsyncTaskHandle : 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 Ws2_32 extends StdCallLibrary {
Ws2_32 INSTANCE = Native.load("ws2_32", Ws2_32.class);
int WSACancelAsyncRequest(
Pointer hAsyncTaskHandle // HANDLE
);
}@[Link("ws2_32")]
lib LibWS2_32
fun WSACancelAsyncRequest = WSACancelAsyncRequest(
hAsyncTaskHandle : 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 WSACancelAsyncRequestNative = Int32 Function(Pointer<Void>);
typedef WSACancelAsyncRequestDart = int Function(Pointer<Void>);
final WSACancelAsyncRequest = DynamicLibrary.open('WS2_32.dll')
.lookupFunction<WSACancelAsyncRequestNative, WSACancelAsyncRequestDart>('WSACancelAsyncRequest');
// hAsyncTaskHandle : HANDLE -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function WSACancelAsyncRequest(
hAsyncTaskHandle: THandle // HANDLE
): Integer; stdcall;
external 'WS2_32.dll' name 'WSACancelAsyncRequest';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "WSACancelAsyncRequest"
c_WSACancelAsyncRequest :: Ptr () -> IO Int32
-- hAsyncTaskHandle : HANDLE -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let wsacancelasyncrequest =
foreign "WSACancelAsyncRequest"
((ptr void) @-> returning int32_t)
(* hAsyncTaskHandle : HANDLE -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library ws2_32 (t "WS2_32.dll"))
(cffi:use-foreign-library ws2_32)
(cffi:defcfun ("WSACancelAsyncRequest" wsacancel-async-request :convention :stdcall) :int32
(h-async-task-handle :pointer)) ; HANDLE
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $WSACancelAsyncRequest = Win32::API::More->new('WS2_32',
'int WSACancelAsyncRequest(HANDLE hAsyncTaskHandle)');
# my $ret = $WSACancelAsyncRequest->Call($hAsyncTaskHandle);
# hAsyncTaskHandle : HANDLE -> HANDLE
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
公式の関連項目
- f WSAAsyncGetHostByAddr — IPアドレスのホスト情報を非同期で取得する。
- f WSAAsyncGetHostByName — ホスト名のホスト情報を非同期で取得する。
- f WSAAsyncGetProtoByName — プロトコル名のプロトコル情報を非同期で取得する。
- f WSAAsyncGetProtoByNumber — プロトコル番号のプロトコル情報を非同期で取得する。
- f WSAAsyncGetServByName — サービス名のサービス情報を非同期で取得する。
- f WSAAsyncGetServByPort — ポート番号のサービス情報を非同期で取得する。