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

SOCKET_ADDRESS_LIST

構造体
サイズx64: 24 バイト / x86: 12 バイト

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

フィールド

フィールドサイズx64x86説明
iAddressCountINT4+0+0リスト内のトランスポートアドレスの数です。
AddressSOCKET_ADDRESS16/8+8+4

SOCKET_ADDRESS 構造体の可変サイズの配列です。SOCKET_ADDRESS 構造体は次のように 定義されています。

typedef struct _SOCKET_ADDRESS {
  LPSOCKADDR  lpSockaddr;
  INT  iSockaddrLength;
} SOCKET_ADDRESS, *PSOCKET_ADDRESS, *LPSOCKET_ADDRESS;

lpSockaddr

トランスポートアドレスを格納するバッファーへのポインターです。

iSockaddrLength

   <b>lpSockaddr</b> メンバーが指す SOCKADDR 構造体型のサイズ (バイト単位) です。

公式ドキュメント

SOCKET_ADDRESS_LIST 構造体は、可変サイズのトランスポートアドレスのリストを定義します。

解説(Remarks)

WSK アプリケーションは、ソケットのアドレスファミリーに一致するローカルトランスポートアドレスの現在のリストを照会するときに、 WskControlSocket 関数にバッファーを渡します。

<b>WskControlSocket</b> 関数の呼び出しが成功すると、そのバッファーには SOCKET_ADDRESS_LIST 構造体と、それに続いて
ソケットのアドレスファミリーに一致する各ローカルトランスポートアドレスの SOCKADDR 構造体が格納されます。
WSK サブシステムは 
<b>Address</b> 配列を設定し、
<b>iAddressCount</b> メンバーに配列内のエントリ数を設定します。
配列内の各 SOCKET_ADDRESS 構造体の 
<b>lpSockaddr</b> ポインターは、WSK アプリケーションがソケットの作成時に指定したアドレスファミリーに対応する、
固有の SOCKADDR 構造体型を指します。

ローカルトランスポートアドレスの現在のリストを照会する方法の詳細については、 SIO_ADDRESS_LIST_QUERY を参照してください。

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

各言語での定義

#include <windows.h>

// SOCKET_ADDRESS  (x64 16 / x86 8 バイト)
typedef struct SOCKET_ADDRESS {
    SOCKADDR* lpSockaddr;
    INT iSockaddrLength;
} SOCKET_ADDRESS;

// SOCKET_ADDRESS_LIST  (x64 24 / x86 12 バイト)
typedef struct SOCKET_ADDRESS_LIST {
    INT iAddressCount;
    SOCKET_ADDRESS Address[1];
} SOCKET_ADDRESS_LIST;
using System;
using System.Runtime.InteropServices;

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct SOCKET_ADDRESS
{
    public IntPtr lpSockaddr;
    public int iSockaddrLength;
}

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct SOCKET_ADDRESS_LIST
{
    public int iAddressCount;
    [MarshalAs(UnmanagedType.ByValArray, SizeConst = 1)] public SOCKET_ADDRESS[] Address;
}
Imports System.Runtime.InteropServices

<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure SOCKET_ADDRESS
    Public lpSockaddr As IntPtr
    Public iSockaddrLength As Integer
End Structure

<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure SOCKET_ADDRESS_LIST
    Public iAddressCount As Integer
    <MarshalAs(UnmanagedType.ByValArray, SizeConst:=1)> Public Address() As SOCKET_ADDRESS
End Structure
import ctypes
from ctypes import wintypes

class SOCKET_ADDRESS(ctypes.Structure):
    _fields_ = [
        ("lpSockaddr", ctypes.c_void_p),
        ("iSockaddrLength", ctypes.c_int),
    ]

class SOCKET_ADDRESS_LIST(ctypes.Structure):
    _fields_ = [
        ("iAddressCount", ctypes.c_int),
        ("Address", SOCKET_ADDRESS * 1),
    ]
#[repr(C)]
pub struct SOCKET_ADDRESS {
    pub lpSockaddr: *mut core::ffi::c_void,
    pub iSockaddrLength: i32,
}

#[repr(C)]
pub struct SOCKET_ADDRESS_LIST {
    pub iAddressCount: i32,
    pub Address: [SOCKET_ADDRESS; 1],
}
import "golang.org/x/sys/windows"

type SOCKET_ADDRESS struct {
	lpSockaddr uintptr
	iSockaddrLength int32
}

type SOCKET_ADDRESS_LIST struct {
	iAddressCount int32
	Address [1]SOCKET_ADDRESS
}
type
  SOCKET_ADDRESS = record
    lpSockaddr: Pointer;
    iSockaddrLength: Integer;
  end;

  SOCKET_ADDRESS_LIST = record
    iAddressCount: Integer;
    Address: array[0..0] of SOCKET_ADDRESS;
  end;
const SOCKET_ADDRESS = extern struct {
    lpSockaddr: ?*anyopaque,
    iSockaddrLength: i32,
};

const SOCKET_ADDRESS_LIST = extern struct {
    iAddressCount: i32,
    Address: [1]SOCKET_ADDRESS,
};
type
  SOCKET_ADDRESS {.bycopy.} = object
    lpSockaddr: pointer
    iSockaddrLength: int32

  SOCKET_ADDRESS_LIST {.bycopy.} = object
    iAddressCount: int32
    Address: array[1, SOCKET_ADDRESS]
struct SOCKET_ADDRESS
{
    void* lpSockaddr;
    int iSockaddrLength;
}

struct SOCKET_ADDRESS_LIST
{
    int iAddressCount;
    SOCKET_ADDRESS[1] Address;
}

HSP用 定義

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

; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x86 レイアウト)
; SOCKET_ADDRESS_LIST サイズ: 12 バイト(x86)
dim st, 3    ; 4byte整数×3(構造体サイズ 12 / 4 切り上げ)
; iAddressCount : INT (+0, 4byte)  st.0 = 値  /  値 = st.0   (lpoke/lpeek も可)
; Address : SOCKET_ADDRESS (+4, 8byte)  varptr(st)+4 を基点に操作(8byte:入れ子/配列)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x64 レイアウト)
; SOCKET_ADDRESS_LIST サイズ: 24 バイト(x64)
dim st, 6    ; 4byte整数×6(構造体サイズ 24 / 4 切り上げ)
; iAddressCount : INT (+0, 4byte)  st.0 = 値  /  値 = st.0   (lpoke/lpeek も可)
; Address : SOCKET_ADDRESS (+8, 16byte)  varptr(st)+8 を基点に操作(16byte:入れ子/配列)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; IronHSP は NSTRUCT(構造体)をサポート。32bit/64bit どちらでも同じコードで動作します。
; ※GUID・入れ子構造体はデフォルト型でないため、依存する #defstruct を先に定義(下記に同梱)。
#defstruct global SOCKET_ADDRESS
    #field intptr lpSockaddr
    #field int iSockaddrLength
#endstruct

#defstruct global SOCKET_ADDRESS_LIST
    #field int iAddressCount
    #field SOCKET_ADDRESS Address 1
#endstruct

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