ホーム › Networking.WinSock › WSAAsyncGetServByPort

WSAAsyncGetServByPort

関数

ポート番号のサービス情報を非同期で取得する。

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

シグネチャ

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

HANDLE WSAAsyncGetServByPort(
    HWND hWnd,
    DWORD wMsg,
    INT port,
    LPCSTR proto,
    LPSTR buf,
    INT buflen
);

パラメーター

名前	型	方向	説明
hWnd	HWND	in	非同期要求が完了したときにメッセージを受け取るウィンドウのハンドル。
wMsg	DWORD	in	非同期要求が完了したときに受け取るメッセージ。
port	INT	in	サービスのポート。ネットワークバイト順で指定します。
proto	LPCSTR	in	プロトコル名へのポインター。NULL を指定できます。その場合、 WSAAsyncGetServByPort は指定した port に s_port が一致する最初のサービスエントリを検索します。それ以外の場合、 WSAAsyncGetServByPort は port と proto の両方に一致するものを検索します。
buf	LPSTR	out	servent データを受け取るデータ領域へのポインター。Windows Sockets はこのデータ領域に servent 構造体と、その servent 構造体のメンバーから参照されるすべてのデータを格納するため、データ領域は servent 構造体のサイズよりも大きくする必要があります。MAXGETHOSTSTRUCT バイトのバッファーを推奨します。
buflen	INT	in	buf パラメーターのデータ領域のサイズ (バイト単位)。

戻り値の型: HANDLE

公式ドキュメント

WSAAsyncGetServByPort 関数 (winsock.h) は、ポートとプロトコルに対応するサービス情報を非同期に取得します。

戻り値

戻り値は、非同期操作が正常に開始されたかどうかを示します。操作自体の成否を示すものではありません。

エラーが発生しなかった場合、 WSAAsyncGetServByPort は要求の非同期タスクハンドルを表す HANDLE 型の 0 以外の値を返します (Windows の HTASK と混同しないでください)。この値は 2 通りの方法で使用できます。 WSACancelAsyncRequest を使用して操作をキャンセルするために使用できるほか、wParam メッセージパラメーターを調べることで、非同期操作と完了メッセージを対応付けるために使用できます。

非同期操作を開始できなかった場合、 WSAAsyncGetServByPort は 0 を返します。具体的なエラー番号は WSAGetLastError を呼び出して取得できます。

アプリケーションウィンドウがメッセージを受け取ったときには、次のエラーコードが設定される場合があります。前述のとおり、これらは応答メッセージ内の lParam から WSAGETASYNCERROR マクロを使用して抽出できます。

エラーコード	意味
WSAENETDOWN	ネットワークサブシステムが失敗しました。
WSAENOBUFS	利用可能なバッファー領域が不足しています。
WSAEFAULT	proto または buf パラメーターが、プロセスアドレス空間の有効な部分にありません。
WSAHOST_NOT_FOUND	信頼できる応答 (authoritative answer) でポートが見つかりませんでした。
WSATRY_AGAIN	信頼できない応答でポートが見つからなかったか、サーバーの障害です。
WSANO_RECOVERY	回復不能なエラーです。サービスデータベースにアクセスできません。
WSANO_DATA	名前は有効ですが、要求された種類のデータレコードがありません。

次のエラーは関数呼び出しの時点で発生する可能性があり、非同期操作を開始できなかったことを示します。

エラーコード	意味
WSANOTINITIALISED	この関数を使用する前に、 WSAStartup の呼び出しが成功している必要があります。
WSAENETDOWN	ネットワークサブシステムが失敗しました。
WSAEINPROGRESS	ブロッキングを伴う Windows Sockets 1.1 の呼び出しが進行中であるか、サービスプロバイダーがコールバック関数を処理中です。
WSAEWOULDBLOCK	Windows Sockets 実装内のリソースまたはその他の制約により、現時点では非同期操作をスケジュールできません。

解説(Remarks)

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

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

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

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

この関数に指定されたバッファーは、Windows Sockets が servent 構造体と、同じ servent 構造体のメンバーから参照されるデータ領域の内容を構築するために使用されます。 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 WSAAsyncGetServByPort(
    HWND hWnd,
    DWORD wMsg,
    INT port,
    LPCSTR proto,
    LPSTR buf,
    INT buflen
);

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

<DllImport("WS2_32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function WSAAsyncGetServByPort(
    hWnd As IntPtr,   ' HWND
    wMsg As UInteger,   ' DWORD
    port As Integer,   ' INT
    <MarshalAs(UnmanagedType.LPStr)> proto 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
' port : INT
' proto : LPCSTR
' buf : LPSTR out
' buflen : INT
Declare PtrSafe Function WSAAsyncGetServByPort Lib "ws2_32" ( _
    ByVal hWnd As LongPtr, _
    ByVal wMsg As Long, _
    ByVal port As Long, _
    ByVal proto 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

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

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

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

出力引数:

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