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

GetAddrInfoExCancel

関数
進行中の拡張アドレス解決要求を取り消す。
DLLWS2_32.dll呼出規約winapi対応OSWindows 8.1 以降

シグネチャ

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

INT GetAddrInfoExCancel(
    HANDLE* lpHandle
);

パラメーター

名前方向説明
lpHandleHANDLE*inキャンセルする非同期操作のハンドル。これは GetAddrInfoEx 関数によって lpNameHandle パラメーターに返されたハンドルです。

戻り値の型: INT

公式ドキュメント

GetAddrInfoEx 関数による非同期操作をキャンセルします。

戻り値

成功した場合、GetAddrInfoExCancelNO_ERROR (0) を返します。失敗した場合は、Windows Sockets Error Codes に記載されている 0 以外の Windows Sockets エラーコードを返します。

解説(Remarks)

GetAddrInfoExCancel 関数は、非同期の GetAddrInfoEx 操作をキャンセルします。その結果、ユーザーの完了通知メカニズム(コールバックまたはイベントのいずれか)がただちに呼び出されます。結果は返されず、GetAddrInfoEx 非同期操作に対して返されるエラーコードは WSA_E_CANCELLED に設定されます。GetAddrInfoEx 要求が既に完了またはタイムアウトしている場合、あるいはハンドルが無効な場合は、GetAddrInfoExCancel 関数によって WSA_INVALID_HANDLE が返されます。

基盤となる操作の多く(例えばレガシーなネームサービスプロバイダー)は同期的であるため、これらの操作は実際にはキャンセルされません。これらの操作は実行を続け、リソースを消費し続けます。未完了のネームサービスプロバイダー要求のうち最後のものが完了すると、リソースが解放されます。

Windows 8.1 および Windows Server 2012 R2: この関数は、Windows 8.1、Windows Server 2012 R2 以降の Windows ストアアプリでサポートされます。

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

各言語での呼び出し定義

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

INT GetAddrInfoExCancel(
    HANDLE* lpHandle
);
[DllImport("WS2_32.dll", ExactSpelling = true)]
static extern int GetAddrInfoExCancel(
    IntPtr lpHandle   // HANDLE*
);
<DllImport("WS2_32.dll", ExactSpelling:=True)>
Public Shared Function GetAddrInfoExCancel(
    lpHandle As IntPtr   ' HANDLE*
) As Integer
End Function
' lpHandle : HANDLE*
Declare PtrSafe Function GetAddrInfoExCancel Lib "ws2_32" ( _
    ByVal lpHandle As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

GetAddrInfoExCancel = ctypes.windll.ws2_32.GetAddrInfoExCancel
GetAddrInfoExCancel.restype = ctypes.c_int
GetAddrInfoExCancel.argtypes = [
    ctypes.c_void_p,  # lpHandle : HANDLE*
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WS2_32.dll')
GetAddrInfoExCancel = Fiddle::Function.new(
  lib['GetAddrInfoExCancel'],
  [
    Fiddle::TYPE_VOIDP,  # lpHandle : HANDLE*
  ],
  Fiddle::TYPE_INT)
#[link(name = "ws2_32")]
extern "system" {
    fn GetAddrInfoExCancel(
        lpHandle: *mut *mut core::ffi::c_void  // HANDLE*
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("WS2_32.dll")]
public static extern int GetAddrInfoExCancel(IntPtr lpHandle);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WS2_32_GetAddrInfoExCancel' -Namespace Win32 -PassThru
# $api::GetAddrInfoExCancel(lpHandle)
#uselib "WS2_32.dll"
#func global GetAddrInfoExCancel "GetAddrInfoExCancel" sptr
; GetAddrInfoExCancel lpHandle   ; 戻り値は stat
; lpHandle : HANDLE* -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "WS2_32.dll"
#cfunc global GetAddrInfoExCancel "GetAddrInfoExCancel" sptr
; res = GetAddrInfoExCancel(lpHandle)
; lpHandle : HANDLE* -> "sptr"
; INT GetAddrInfoExCancel(HANDLE* lpHandle)
#uselib "WS2_32.dll"
#cfunc global GetAddrInfoExCancel "GetAddrInfoExCancel" intptr
; res = GetAddrInfoExCancel(lpHandle)
; lpHandle : HANDLE* -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	ws2_32 = windows.NewLazySystemDLL("WS2_32.dll")
	procGetAddrInfoExCancel = ws2_32.NewProc("GetAddrInfoExCancel")
)

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

extern "ws2_32" fn GetAddrInfoExCancel(
    lpHandle: ?*anyopaque // HANDLE*
) callconv(std.os.windows.WINAPI) i32;
proc GetAddrInfoExCancel(
    lpHandle: pointer  # HANDLE*
): int32 {.importc: "GetAddrInfoExCancel", stdcall, dynlib: "WS2_32.dll".}
pragma(lib, "ws2_32");
extern(Windows)
int GetAddrInfoExCancel(
    void* lpHandle   // HANDLE*
);
ccall((:GetAddrInfoExCancel, "WS2_32.dll"), stdcall, Int32,
      (Ptr{Cvoid},),
      lpHandle)
# lpHandle : HANDLE* -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t GetAddrInfoExCancel(
    void* lpHandle);
]]
local ws2_32 = ffi.load("ws2_32")
-- ws2_32.GetAddrInfoExCancel(lpHandle)
-- lpHandle : HANDLE*
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('WS2_32.dll');
const GetAddrInfoExCancel = lib.func('__stdcall', 'GetAddrInfoExCancel', 'int32_t', ['void *']);
// GetAddrInfoExCancel(lpHandle)
// lpHandle : HANDLE* -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("WS2_32.dll", {
  GetAddrInfoExCancel: { parameters: ["pointer"], result: "i32" },
});
// lib.symbols.GetAddrInfoExCancel(lpHandle)
// lpHandle : HANDLE* -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t GetAddrInfoExCancel(
    void* lpHandle);
C, "WS2_32.dll");
// $ffi->GetAddrInfoExCancel(lpHandle);
// lpHandle : 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 GetAddrInfoExCancel(
        Pointer lpHandle   // HANDLE*
    );
}
@[Link("ws2_32")]
lib LibWS2_32
  fun GetAddrInfoExCancel = GetAddrInfoExCancel(
    lpHandle : 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 GetAddrInfoExCancelNative = Int32 Function(Pointer<Void>);
typedef GetAddrInfoExCancelDart = int Function(Pointer<Void>);
final GetAddrInfoExCancel = DynamicLibrary.open('WS2_32.dll')
    .lookupFunction<GetAddrInfoExCancelNative, GetAddrInfoExCancelDart>('GetAddrInfoExCancel');
// lpHandle : HANDLE* -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function GetAddrInfoExCancel(
  lpHandle: Pointer   // HANDLE*
): Integer; stdcall;
  external 'WS2_32.dll' name 'GetAddrInfoExCancel';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "GetAddrInfoExCancel"
  c_GetAddrInfoExCancel :: Ptr () -> IO Int32
-- lpHandle : HANDLE* -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let getaddrinfoexcancel =
  foreign "GetAddrInfoExCancel"
    ((ptr void) @-> returning int32_t)
(* lpHandle : 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 ("GetAddrInfoExCancel" get-addr-info-ex-cancel :convention :stdcall) :int32
  (lp-handle :pointer))   ; HANDLE*
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $GetAddrInfoExCancel = Win32::API::More->new('WS2_32',
    'int GetAddrInfoExCancel(HANDLE lpHandle)');
# my $ret = $GetAddrInfoExCancel->Call($lpHandle);
# lpHandle : HANDLE* -> HANDLE
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目