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

WSADATA

構造体
サイズx64: 408 バイト / x86: 400 バイト

サイズ=各フィールドのバイト数(x64/x86 で異なる場合は x64/x86 と併記)。x64/x86 列=フィールドのバイトオフセット(HSPで dupptr / lpoke / wpoke 等に使用)。

フィールド

フィールドサイズx64x86説明
wVersionWORD2+0+0Ws2_32.dll が呼び出し元に使用を期待する Windows Sockets 仕様のバージョンです。上位バイトはマイナーバージョン番号を、下位バイトはメジャーバージョン番号を指定します。
wHighVersionWORD2+2+2

Ws2_32.dll がサポートできる Windows Sockets 仕様の最上位のバージョンです。上位バイトはマイナーバージョン番号を、下位バイトはメジャーバージョン番号を指定します。

WSAStartup 関数に渡した wVersionRequested パラメーターで要求したバージョンが、Ws2_32.dll がサポートできる Windows Sockets 仕様の最上位のバージョンである場合、この値は wVersion メンバーと同じ値になります。

szDescriptionCHAR257+4+4Ws2_32.dll が Windows Sockets 実装の説明をコピーする、NULL 終端の ASCII 文字列です。このテキスト (最大 256 文字) には、制御文字と書式設定文字を除く任意の文字を含めることができます。アプリケーションにおけるこのメンバーの最も一般的な用途は、(必要に応じて切り詰めて) ステータスメッセージとして表示することです。
szSystemStatusCHAR129+261+261Ws2_32.dll が関連するステータス情報または構成情報をコピーする、NULL 終端の ASCII 文字列です。Ws2_32.dll は、その情報がユーザーまたはサポート担当者にとって有用な場合にのみ、このパラメーターを使用します。このメンバーを szDescription パラメーターの拡張と見なすべきではありません。
iMaxSocketsWORD2+390+390

オープンできるソケットの最大数です。このメンバーは Windows Sockets バージョン 2 以降では無視してください。

iMaxSockets メンバーは Windows Sockets 仕様 1.1 との互換性のために残されていますが、新しいアプリケーションの開発では使用しないでください。基盤となるすべてのサービスプロバイダーに適した単一の値は存在しません。Windows Sockets のアーキテクチャはバージョン 2 で複数のプロバイダーをサポートするように変更されたため、WSADATA 構造体は単一のベンダーのスタックには当てはまらなくなりました。

iMaxUdpDgWORD2+392+392

データグラムメッセージの最大サイズです。このメンバーは Windows Sockets バージョン 2 以降では無視されます。

iMaxUdpDg メンバーは Windows Sockets 仕様 1.1 との互換性のために残されていますが、新しいアプリケーションの開発では使用しないでください。Windows Sockets のアーキテクチャはバージョン 2 で複数のプロバイダーをサポートするように変更されたため、WSADATA 構造体は単一のベンダーのスタックには当てはまらなくなりました。特定の Windows Sockets サービスプロバイダーおよびソケットの種類に固有の実際の最大メッセージサイズについては、ソケットの作成後に getsockopt を使用して SO_MAX_MSG_SIZE オプションの値を取得してください。

lpVendorInfoLPSTR8/4+400+396

ベンダー固有の情報へのポインターです。このメンバーは Windows Sockets バージョン 2 以降では無視してください。

lpVendorInfo メンバーは Windows Sockets 仕様 1.1 との互換性のために残されています。Windows Sockets のアーキテクチャはバージョン 2 で複数のプロバイダーをサポートするように変更されたため、WSADATA 構造体は単一のベンダーのスタックには当てはまらなくなりました。ベンダー固有の構成情報にアクセスする必要があるアプリケーションは、 getsockopt を使用して PVD_CONFIG オプションの値を取得し、ベンダー固有の情報を参照してください。

公式ドキュメント

WSADATA 構造体は、Windows Sockets 実装に関する情報を保持します。

解説(Remarks)

WSAStartup 関数は、プロセスによる Windows Sockets DLL の使用を開始します。WSAStartup 関数は、lpWSAData パラメーターで WSADATA 構造体へのポインターを返します。

WSADATA 構造体の wHighVersion メンバーで返される Windows Sockets 仕様の現在のバージョンは 2.2 で、下位バイトにメジャーバージョン番号、上位バイトにマイナーバージョン番号がエンコードされています。現在の Winsock DLL である Ws2_32.dll のこのバージョンは、次のいずれかのバージョンの Windows Sockets 仕様を要求するアプリケーションをサポートします。

アプリケーションが要求したバージョンに応じて、上記のいずれかのバージョン番号が、下位バイトにメジャーバージョン番号、上位バイトにマイナーバージョン番号としてエンコードされた値となり、WSADATA 構造体の wVersion メンバーで返されます。
メモ WSAStartup の呼び出しに成功した後の wVersion の値が 2 以上である場合、アプリケーションは WSADATAiMaxsocketsiMaxUdpDglpVendorInfo の各メンバーを無視してください。これは、Windows Sockets のアーキテクチャがバージョン 2 で複数のプロバイダーをサポートするように変更され、WSADATA が単一のベンダーのスタックには当てはまらなくなったためです。プロバイダー固有の情報を提供するために、2 つの新しいソケットオプションが導入されています。SO_MAX_MSG_SIZE (iMaxUdpDg メンバーを置き換えます) と PVD_CONFIG (その他のプロバイダー固有の構成を取得できます) です。

次の例は、WSADATA 構造体の使用方法を示します。

WORD wVersionRequested;
WSADATA wsaData;
int err;
 
wVersionRequested = MAKEWORD( 2, 2 );
 
err = WSAStartup( wVersionRequested, &wsaData );
if ( err != 0 ) {
    /* Tell the user that we could not find a usable */
    /* WinSock DLL.                                  */
    return;
}
 
/* Confirm that the WinSock DLL supports 2.2.*/
/* Note that if the DLL supports versions greater    */
/* than 2.2 in addition to 2.2, it will still return */
/* 2.2 in wVersion since that is the version we      */
/* requested.                                        */
 
if ( LOBYTE( wsaData.wVersion ) != 2 ||
        HIBYTE( wsaData.wVersion ) != 2 ) {
    /* Tell the user that we could not find a usable */
    /* WinSock DLL.                                  */
    WSACleanup( );
    return; 
}
 
/* The WinSock DLL is acceptable. Proceed. */



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

各言語での定義

#include <windows.h>

// WSADATA  (x64 408 / x86 400 バイト)
typedef struct WSADATA {
    WORD wVersion;
    WORD wHighVersion;
    CHAR szDescription[257];
    CHAR szSystemStatus[129];
    WORD iMaxSockets;
    WORD iMaxUdpDg;
    LPSTR lpVendorInfo;
} WSADATA;
using System;
using System.Runtime.InteropServices;

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct WSADATA
{
    public ushort wVersion;
    public ushort wHighVersion;
    [MarshalAs(UnmanagedType.ByValArray, SizeConst = 257)] public sbyte[] szDescription;
    [MarshalAs(UnmanagedType.ByValArray, SizeConst = 129)] public sbyte[] szSystemStatus;
    public ushort iMaxSockets;
    public ushort iMaxUdpDg;
    public IntPtr lpVendorInfo;
}
Imports System.Runtime.InteropServices

<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure WSADATA
    Public wVersion As UShort
    Public wHighVersion As UShort
    <MarshalAs(UnmanagedType.ByValArray, SizeConst:=257)> Public szDescription() As SByte
    <MarshalAs(UnmanagedType.ByValArray, SizeConst:=129)> Public szSystemStatus() As SByte
    Public iMaxSockets As UShort
    Public iMaxUdpDg As UShort
    Public lpVendorInfo As IntPtr
End Structure
import ctypes
from ctypes import wintypes

class WSADATA(ctypes.Structure):
    _fields_ = [
        ("wVersion", ctypes.c_ushort),
        ("wHighVersion", ctypes.c_ushort),
        ("szDescription", ctypes.c_byte * 257),
        ("szSystemStatus", ctypes.c_byte * 129),
        ("iMaxSockets", ctypes.c_ushort),
        ("iMaxUdpDg", ctypes.c_ushort),
        ("lpVendorInfo", ctypes.c_void_p),
    ]
#[repr(C)]
pub struct WSADATA {
    pub wVersion: u16,
    pub wHighVersion: u16,
    pub szDescription: [i8; 257],
    pub szSystemStatus: [i8; 129],
    pub iMaxSockets: u16,
    pub iMaxUdpDg: u16,
    pub lpVendorInfo: *mut core::ffi::c_void,
}
import "golang.org/x/sys/windows"

type WSADATA struct {
	wVersion uint16
	wHighVersion uint16
	szDescription [257]int8
	szSystemStatus [129]int8
	iMaxSockets uint16
	iMaxUdpDg uint16
	lpVendorInfo uintptr
}
type
  WSADATA = record
    wVersion: Word;
    wHighVersion: Word;
    szDescription: array[0..256] of Shortint;
    szSystemStatus: array[0..128] of Shortint;
    iMaxSockets: Word;
    iMaxUdpDg: Word;
    lpVendorInfo: Pointer;
  end;
const WSADATA = extern struct {
    wVersion: u16,
    wHighVersion: u16,
    szDescription: [257]i8,
    szSystemStatus: [129]i8,
    iMaxSockets: u16,
    iMaxUdpDg: u16,
    lpVendorInfo: ?*anyopaque,
};
type
  WSADATA {.bycopy.} = object
    wVersion: uint16
    wHighVersion: uint16
    szDescription: array[257, int8]
    szSystemStatus: array[129, int8]
    iMaxSockets: uint16
    iMaxUdpDg: uint16
    lpVendorInfo: pointer
struct WSADATA
{
    ushort wVersion;
    ushort wHighVersion;
    byte[257] szDescription;
    byte[129] szSystemStatus;
    ushort iMaxSockets;
    ushort iMaxUdpDg;
    void* lpVendorInfo;
}

HSP用 定義

HSP3.7/3.8 は構造体機能が無いため4byte整数配列(dim)+peek/poke で操作(32/64bitでサイズ・位置が異なる場合はタブで分割)。IronHSP は NSTRUCT(#defstruct/stdim/->)で32/64bit共通。

; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x86 レイアウト)
; WSADATA サイズ: 400 バイト(x86)
dim st, 100    ; 4byte整数×100(構造体サイズ 400 / 4 切り上げ)
; wVersion : WORD (+0, 2byte)  wpoke st,0,値  /  値 = wpeek(st,0)
; wHighVersion : WORD (+2, 2byte)  wpoke st,2,値  /  値 = wpeek(st,2)
; szDescription : CHAR (+4, 257byte)  varptr(st)+4 を基点に操作(257byte:入れ子/配列)
; szSystemStatus : CHAR (+261, 129byte)  varptr(st)+261 を基点に操作(129byte:入れ子/配列)
; iMaxSockets : WORD (+390, 2byte)  wpoke st,390,値  /  値 = wpeek(st,390)
; iMaxUdpDg : WORD (+392, 2byte)  wpoke st,392,値  /  値 = wpeek(st,392)
; lpVendorInfo : LPSTR (+396, 4byte)  st.99 = 値  /  値 = st.99   (lpoke/lpeek も可)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x64 レイアウト)
; WSADATA サイズ: 408 バイト(x64)
dim st, 102    ; 4byte整数×102(構造体サイズ 408 / 4 切り上げ)
; wVersion : WORD (+0, 2byte)  wpoke st,0,値  /  値 = wpeek(st,0)
; wHighVersion : WORD (+2, 2byte)  wpoke st,2,値  /  値 = wpeek(st,2)
; szDescription : CHAR (+4, 257byte)  varptr(st)+4 を基点に操作(257byte:入れ子/配列)
; szSystemStatus : CHAR (+261, 129byte)  varptr(st)+261 を基点に操作(129byte:入れ子/配列)
; iMaxSockets : WORD (+390, 2byte)  wpoke st,390,値  /  値 = wpeek(st,390)
; iMaxUdpDg : WORD (+392, 2byte)  wpoke st,392,値  /  値 = wpeek(st,392)
; lpVendorInfo : LPSTR (+400, 8byte)  qpoke st,400,値 / qpeek(st,400)  ※IronHSPのみ。3.7/3.8は lpoke st,400,下位 : lpoke st,404,上位
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; IronHSP は NSTRUCT(構造体)をサポート。32bit/64bit どちらでも同じコードで動作します。
#defstruct global WSADATA
    #field short wVersion
    #field short wHighVersion
    #field byte szDescription 257
    #field byte szSystemStatus 129
    #field short iMaxSockets
    #field short iMaxUdpDg
    #field intptr lpVendorInfo
#endstruct

stdim st, WSADATA        ; NSTRUCT 変数を確保
st->wVersion = 100
mes "wVersion=" + st->wVersion