ホーム › Networking.WinSock › WSAAsyncGetHostByAddr

WSAAsyncGetHostByAddr

関数

IPアドレスのホスト情報を非同期で取得する。

DLLWS2_32.dll呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

HANDLE WSAAsyncGetHostByAddr(
    HWND hWnd,
    DWORD wMsg,
    LPCSTR addr,
    INT len,
    INT type,
    LPSTR buf,
    INT buflen
);

パラメーター

名前	型	方向	説明
hWnd	HWND	in	完了時にメッセージを受け取るウィンドウのハンドル。
wMsg	DWORD	in	操作完了時にウィンドウへポストするメッセージID。
addr	LPCSTR	in	検索対象のネットワークアドレスへのポインタ(ネットワークバイトオーダー)。
len	INT	in	addrが指すアドレスのバイト長(IPv4なら4)。
type	INT	in	アドレスファミリを指定する(通常AF_INET)。
buf	LPSTR	out	結果のhostent構造体を格納するバッファへのポインタ。呼び出し側が確保する。
buflen	INT	in	bufバッファのサイズをバイト単位で指定する。MAXGETHOSTSTRUCT推奨。

戻り値の型: HANDLE

公式ドキュメント

WSAAsyncGetHostByAddr マクロ関数 (wsipv6ok.h) は、あるアドレスに対応するホスト情報を非同期に取得します。

解説(Remarks)

WSAAsyncGetHostByAddr 関数は gethostbyaddr の非同期版です。ネットワークアドレスに対応するホスト名とアドレス情報を取得するために使用します。Windows Sockets は操作を開始すると直ちに呼び出し元へ戻り、アプリケーションが操作を識別するために使用できる不透明な非同期タスクハンドルを返します。操作が完了すると、結果 (存在する場合) は呼び出し元が用意したバッファーへコピーされ、アプリケーションのウィンドウへメッセージが送信されます。

非同期操作が完了すると、hWnd パラメーターで指定されたアプリケーションウィンドウが wMsg パラメーターのメッセージを受け取ります。wParam パラメーターには、元の関数呼び出しが返した非同期タスクハンドルが格納されます。lParam の上位 16 ビットにはエラーコード (存在する場合) が格納されます。エラーコードは Winsock2.h で定義されている任意のエラーになり得ます。エラーコードがゼロの場合は、非同期操作が正常に完了したことを示します。

正常に完了すると、元の関数呼び出しで指定したバッファーには hostent 構造体が格納されます。この構造体のメンバーにアクセスするには、元のバッファーアドレスを hostent 構造体ポインターにキャストし、適切にアクセスします。

エラーコードが WSAENOBUFS の場合、元の呼び出しで buflen に指定したバッファーのサイズが、結果として得られるすべての情報を格納するには小さすぎたことを意味します。この場合、lParam の下位 16 ビットには、必要なすべての情報を得るために必要なバッファーのサイズが格納されます。アプリケーションが部分的なデータでは不十分と判断した場合は、必要なすべての情報を受け取るのに十分な大きさのバッファー (すなわち lParam の下位 16 ビットを下回らないサイズ) を指定して WSAAsyncGetHostByAddr 関数呼び出しを再発行できます。

この関数に指定するバッファーは、Windows Sockets が同一の hostent 構造体のメンバーから参照されるデータ領域の内容とともに構造体を構築するために使用します。 WSAENOBUFS エラーを回避するため、アプリケーションは少なくとも MAXGETHOSTSTRUCT バイト (Winsock2.h で定義) のバッファーを用意してください。

エラーコードとバッファー長は、Winsock2.h で次のように定義されているマクロ WSAGETASYNCERROR および WSAGETASYNCBUFLEN を使用して lParam から取り出してください。

#include <windows.h>

#define WSAGETASYNCBUFLEN(lParam)           LOWORD(lParam)
#define WSAGETASYNCERROR(lParam)            HIWORD(lParam)

これらのマクロを使用することで、アプリケーションのソースコードの移植性を最大限に高められます。

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

各言語での呼び出し定義

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

HANDLE WSAAsyncGetHostByAddr(
    HWND hWnd,
    DWORD wMsg,
    LPCSTR addr,
    INT len,
    INT type,
    LPSTR buf,
    INT buflen
);

[DllImport("WS2_32.dll", SetLastError = true, ExactSpelling = true)]
static extern IntPtr WSAAsyncGetHostByAddr(
    IntPtr hWnd,   // HWND
    uint wMsg,   // DWORD
    [MarshalAs(UnmanagedType.LPStr)] string addr,   // LPCSTR
    int len,   // INT
    int type,   // INT
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder buf,   // LPSTR out
    int buflen   // INT
);

<DllImport("WS2_32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function WSAAsyncGetHostByAddr(
    hWnd As IntPtr,   ' HWND
    wMsg As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPStr)> addr As String,   ' LPCSTR
    len As Integer,   ' INT
    type As Integer,   ' INT
    <MarshalAs(UnmanagedType.LPStr)> buf As System.Text.StringBuilder,   ' LPSTR out
    buflen As Integer   ' INT
) As IntPtr
End Function

' hWnd : HWND
' wMsg : DWORD
' addr : LPCSTR
' len : INT
' type : INT
' buf : LPSTR out
' buflen : INT
Declare PtrSafe Function WSAAsyncGetHostByAddr Lib "ws2_32" ( _
    ByVal hWnd As LongPtr, _
    ByVal wMsg As Long, _
    ByVal addr As String, _
    ByVal len As Long, _
    ByVal type As Long, _
    ByVal buf As String, _
    ByVal buflen As Long) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

WSAAsyncGetHostByAddr = ctypes.windll.ws2_32.WSAAsyncGetHostByAddr
WSAAsyncGetHostByAddr.restype = ctypes.c_void_p
WSAAsyncGetHostByAddr.argtypes = [
    wintypes.HANDLE,  # hWnd : HWND
    wintypes.DWORD,  # wMsg : DWORD
    wintypes.LPCSTR,  # addr : LPCSTR
    ctypes.c_int,  # len : INT
    ctypes.c_int,  # type : INT
    wintypes.LPSTR,  # buf : LPSTR out
    ctypes.c_int,  # buflen : INT
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WS2_32.dll')
WSAAsyncGetHostByAddr = Fiddle::Function.new(
  lib['WSAAsyncGetHostByAddr'],
  [
    Fiddle::TYPE_VOIDP,  # hWnd : HWND
    -Fiddle::TYPE_INT,  # wMsg : DWORD
    Fiddle::TYPE_VOIDP,  # addr : LPCSTR
    Fiddle::TYPE_INT,  # len : INT
    Fiddle::TYPE_INT,  # type : INT
    Fiddle::TYPE_VOIDP,  # buf : LPSTR out
    Fiddle::TYPE_INT,  # buflen : INT
  ],
  Fiddle::TYPE_VOIDP)

#[link(name = "ws2_32")]
extern "system" {
    fn WSAAsyncGetHostByAddr(
        hWnd: *mut core::ffi::c_void,  // HWND
        wMsg: u32,  // DWORD
        addr: *const u8,  // LPCSTR
        len: i32,  // INT
        type: i32,  // INT
        buf: *mut u8,  // LPSTR out
        buflen: i32  // INT
    ) -> *mut core::ffi::c_void;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("WS2_32.dll", SetLastError = true)]
public static extern IntPtr WSAAsyncGetHostByAddr(IntPtr hWnd, uint wMsg, [MarshalAs(UnmanagedType.LPStr)] string addr, int len, int type, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder buf, int buflen);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WS2_32_WSAAsyncGetHostByAddr' -Namespace Win32 -PassThru
# $api::WSAAsyncGetHostByAddr(hWnd, wMsg, addr, len, type, buf, buflen)

#uselib "WS2_32.dll"
#func global WSAAsyncGetHostByAddr "WSAAsyncGetHostByAddr" sptr, sptr, sptr, sptr, sptr, sptr, sptr
; WSAAsyncGetHostByAddr hWnd, wMsg, addr, len, type, varptr(buf), buflen   ; 戻り値は stat
; hWnd : HWND -> "sptr"
; wMsg : DWORD -> "sptr"
; addr : LPCSTR -> "sptr"
; len : INT -> "sptr"
; type : INT -> "sptr"
; buf : LPSTR out -> "sptr"
; buflen : INT -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "WS2_32.dll"
#cfunc global WSAAsyncGetHostByAddr "WSAAsyncGetHostByAddr" sptr, int, str, int, int, var, int
; res = WSAAsyncGetHostByAddr(hWnd, wMsg, addr, len, type, buf, buflen)
; hWnd : HWND -> "sptr"
; wMsg : DWORD -> "int"
; addr : LPCSTR -> "str"
; len : INT -> "int"
; type : INT -> "int"
; buf : LPSTR out -> "var"
; buflen : INT -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "WS2_32.dll"
#cfunc global WSAAsyncGetHostByAddr "WSAAsyncGetHostByAddr" sptr, int, str, int, int, sptr, int
; res = WSAAsyncGetHostByAddr(hWnd, wMsg, addr, len, type, varptr(buf), buflen)
; hWnd : HWND -> "sptr"
; wMsg : DWORD -> "int"
; addr : LPCSTR -> "str"
; len : INT -> "int"
; type : INT -> "int"
; buf : LPSTR out -> "sptr"
; buflen : INT -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。