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

GetAddrInfoExOverlappedResult

関数
拡張アドレス解決のオーバーラップ操作結果を取得する。
DLLWS2_32.dll呼出規約winapi対応OSWindows 8.1 以降

シグネチャ

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

INT GetAddrInfoExOverlappedResult(
    OVERLAPPED* lpOverlapped
);

パラメーター

名前方向説明
lpOverlappedOVERLAPPED*in非同期操作のための OVERLAPPED 構造体へのポインター。

戻り値の型: INT

公式ドキュメント

GetAddrInfoEx 関数の非同期操作で使用される OVERLAPPED 構造体のリターンコードを取得します。

戻り値

成功した場合、GetAddrInfoExOverlappedResult 関数は NO_ERROR (0) を返します。基になる操作がまだ完了していない場合、GetAddrInfoExOverlappedResult 関数は WSAEINPROGRESS を返します。失敗した場合、GetAddrInfoExOverlappedResult 関数は WSAEINVAL を返します。

解説(Remarks)

GetAddrInfoExOverlappedResult 関数は、非同期操作のために GetAddrInfoEx 関数とともに使用されます。

GetAddrInfoExOverlappedResult 関数が WSAEINVAL を返した場合、そのエラーを返したのが GetAddrInfoExOverlappedResult 関数なのか非同期操作なのかを区別する唯一の方法は、lpOverlapped パラメーターが NULL でなかったかどうかを確認することです。lpOverlapped パラメーターが NULL であった場合は、GetAddrInfoExOverlappedResult 関数に NULL ポインターが渡されて失敗したことになります。

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

GetAddrInfoExOverlappedResult = ctypes.windll.ws2_32.GetAddrInfoExOverlappedResult
GetAddrInfoExOverlappedResult.restype = ctypes.c_int
GetAddrInfoExOverlappedResult.argtypes = [
    ctypes.c_void_p,  # lpOverlapped : OVERLAPPED*
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WS2_32.dll')
GetAddrInfoExOverlappedResult = Fiddle::Function.new(
  lib['GetAddrInfoExOverlappedResult'],
  [
    Fiddle::TYPE_VOIDP,  # lpOverlapped : OVERLAPPED*
  ],
  Fiddle::TYPE_INT)
#[link(name = "ws2_32")]
extern "system" {
    fn GetAddrInfoExOverlappedResult(
        lpOverlapped: *mut OVERLAPPED  // OVERLAPPED*
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("WS2_32.dll")]
public static extern int GetAddrInfoExOverlappedResult(IntPtr lpOverlapped);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WS2_32_GetAddrInfoExOverlappedResult' -Namespace Win32 -PassThru
# $api::GetAddrInfoExOverlappedResult(lpOverlapped)
#uselib "WS2_32.dll"
#func global GetAddrInfoExOverlappedResult "GetAddrInfoExOverlappedResult" sptr
; GetAddrInfoExOverlappedResult varptr(lpOverlapped)   ; 戻り値は stat
; lpOverlapped : OVERLAPPED* -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "WS2_32.dll"
#cfunc global GetAddrInfoExOverlappedResult "GetAddrInfoExOverlappedResult" var
; res = GetAddrInfoExOverlappedResult(lpOverlapped)
; lpOverlapped : OVERLAPPED* -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; INT GetAddrInfoExOverlappedResult(OVERLAPPED* lpOverlapped)
#uselib "WS2_32.dll"
#cfunc global GetAddrInfoExOverlappedResult "GetAddrInfoExOverlappedResult" var
; res = GetAddrInfoExOverlappedResult(lpOverlapped)
; lpOverlapped : OVERLAPPED* -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	ws2_32 = windows.NewLazySystemDLL("WS2_32.dll")
	procGetAddrInfoExOverlappedResult = ws2_32.NewProc("GetAddrInfoExOverlappedResult")
)

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

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

typedef GetAddrInfoExOverlappedResultNative = Int32 Function(Pointer<Void>);
typedef GetAddrInfoExOverlappedResultDart = int Function(Pointer<Void>);
final GetAddrInfoExOverlappedResult = DynamicLibrary.open('WS2_32.dll')
    .lookupFunction<GetAddrInfoExOverlappedResultNative, GetAddrInfoExOverlappedResultDart>('GetAddrInfoExOverlappedResult');
// lpOverlapped : OVERLAPPED* -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function GetAddrInfoExOverlappedResult(
  lpOverlapped: Pointer   // OVERLAPPED*
): Integer; stdcall;
  external 'WS2_32.dll' name 'GetAddrInfoExOverlappedResult';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

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

関連項目

公式の関連項目
使用する型