ホーム › Networking.WinSock › WSAAsyncGetHostByName

WSAAsyncGetHostByName

関数

ホスト名のホスト情報を非同期で取得する。

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

シグネチャ

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

HANDLE WSAAsyncGetHostByName(
    HWND hWnd,
    DWORD wMsg,
    LPCSTR name,
    LPSTR buf,
    INT buflen
);

パラメーター

名前	型	方向	説明
hWnd	HWND	in	完了時にメッセージを受け取るウィンドウのハンドル。
wMsg	DWORD	in	操作完了時にウィンドウへポストするメッセージID。
name	LPCSTR	in	検索対象のホスト名文字列を指定する。
buf	LPSTR	out	結果のhostent構造体を格納するバッファへのポインタ。呼び出し側が確保する。
buflen	INT	in	bufバッファのサイズをバイト単位で指定する。MAXGETHOSTSTRUCT推奨。

戻り値の型: HANDLE

公式ドキュメント

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

解説(Remarks)

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

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

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

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

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

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

#include <windows.h>

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

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

WSAAsyncGetHostByName は、 gethostname の呼び出しが成功して返された文字列を解決することが保証されています。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 WSAAsyncGetHostByName(
    HWND hWnd,
    DWORD wMsg,
    LPCSTR name,
    LPSTR buf,
    INT buflen
);

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

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

' hWnd : HWND
' wMsg : DWORD
' name : LPCSTR
' buf : LPSTR out
' buflen : INT
Declare PtrSafe Function WSAAsyncGetHostByName Lib "ws2_32" ( _
    ByVal hWnd As LongPtr, _
    ByVal wMsg As Long, _
    ByVal name As String, _
    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

WSAAsyncGetHostByName = ctypes.windll.ws2_32.WSAAsyncGetHostByName
WSAAsyncGetHostByName.restype = ctypes.c_void_p
WSAAsyncGetHostByName.argtypes = [
    wintypes.HANDLE,  # hWnd : HWND
    wintypes.DWORD,  # wMsg : DWORD
    wintypes.LPCSTR,  # name : LPCSTR
    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')
WSAAsyncGetHostByName = Fiddle::Function.new(
  lib['WSAAsyncGetHostByName'],
  [
    Fiddle::TYPE_VOIDP,  # hWnd : HWND
    -Fiddle::TYPE_INT,  # wMsg : DWORD
    Fiddle::TYPE_VOIDP,  # name : LPCSTR
    Fiddle::TYPE_VOIDP,  # buf : LPSTR out
    Fiddle::TYPE_INT,  # buflen : INT
  ],
  Fiddle::TYPE_VOIDP)

#[link(name = "ws2_32")]
extern "system" {
    fn WSAAsyncGetHostByName(
        hWnd: *mut core::ffi::c_void,  // HWND
        wMsg: u32,  // DWORD
        name: *const u8,  // LPCSTR
        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 WSAAsyncGetHostByName(IntPtr hWnd, uint wMsg, [MarshalAs(UnmanagedType.LPStr)] string name, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder buf, int buflen);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WS2_32_WSAAsyncGetHostByName' -Namespace Win32 -PassThru
# $api::WSAAsyncGetHostByName(hWnd, wMsg, name, buf, buflen)

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

出力引数:

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