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

PROTOCOL_INFOA

構造体
サイズx64: 40 バイト / x86: 32 バイト

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

フィールド

フィールドサイズx64x86説明
dwServiceFlagsDWORD4+0+0

プロトコルが提供するサービスを指定するビットフラグのセットです。次のビットフラグのうち 1 つ以上が設定される場合があります。

意味
XP_CONNECTIONLESS
このフラグが設定されている場合、プロトコルはコネクションレス(データグラム)サービスを提供します。このフラグがクリアされている場合、プロトコルはコネクション指向のデータ転送を提供します。
XP_GUARANTEED_DELIVERY
このフラグが設定されている場合、プロトコルは送信されたすべてのデータが目的の宛先に到達することを保証します。このフラグがクリアされている場合、そのような保証はありません。
XP_GUARANTEED_ORDER
このフラグが設定されている場合、プロトコルはデータが送信された順序で到着することを保証します。この特性はデータの順序のみを保証するものであり、配信を保証するものではないことに注意してください。このフラグがクリアされている場合、送信されたデータの順序は保証されません。
XP_MESSAGE_ORIENTED
このフラグが設定されている場合、プロトコルはメッセージ指向です。メッセージ指向のプロトコルはメッセージ境界を尊重します。このフラグがクリアされている場合、プロトコルはストリーム指向であり、メッセージ境界という概念は関係ありません。
XP_PSEUDO_STREAM
このフラグが設定されている場合、プロトコルはメッセージ指向でありながら、すべての受信操作でメッセージ境界を無視します。

このオプション機能は、プロトコルにメッセージをフレーム化させたくない場合に役立ちます。ストリーム指向の特性を必要とするアプリケーションは、この機能をサポートするトランスポートプロトコルに対して、iSocketType の値に関係なく type に SOCK_STREAM を指定してソケットを開くことができます。

XP_GRACEFUL_CLOSE
このフラグが設定されている場合、プロトコルは 2 フェーズのクローズ操作(グレースフルクローズ操作とも呼ばれます)をサポートします。このフラグがクリアされている場合、プロトコルは強制的なクローズ操作のみをサポートします。
XP_EXPEDITED_DATA
このフラグが設定されている場合、プロトコルは緊急データ(expedited data、urgent data とも呼ばれます)をサポートします。
XP_CONNECT_DATA
このフラグが設定されている場合、プロトコルは接続データ(connect data)をサポートします。
XP_DISCONNECT_DATA
このフラグが設定されている場合、プロトコルは切断データ(disconnect data)をサポートします。
XP_SUPPORTS_BROADCAST
このフラグが設定されている場合、プロトコルはブロードキャスト機構をサポートします。
XP_SUPPORTS_MULTICAST
このフラグが設定されている場合、プロトコルはマルチキャスト機構をサポートします。
XP_BANDWIDTH_ALLOCATION
このフラグが設定されている場合、プロトコルはアプリケーションに保証帯域幅を割り当てる機構をサポートします。
XP_FRAGMENTATION
このフラグが設定されている場合、プロトコルはメッセージのフラグメンテーションをサポートします。物理ネットワークの MTU はアプリケーションから隠蔽されます。
XP_ENCRYPTS
このフラグが設定されている場合、プロトコルはデータの暗号化をサポートします。
iAddressFamilyINT4+4+4プロトコル用のソケットを開くために socket 関数を呼び出す際に、af パラメーターとして渡す値です。このアドレスファミリー値は、プロトコルが使用するプロトコルアドレス( sockaddr 構造体とも呼ばれます)の構造を一意に定義します。
iMaxSockAddrINT4+8+8プロトコルがサポートするソケットアドレスの最大長(バイト単位)です。
iMinSockAddrINT4+12+12プロトコルがサポートするソケットアドレスの最小長(バイト単位)です。
iSocketTypeINT4+16+16

プロトコル用のソケットを開くために socket 関数を呼び出す際に、type パラメーターとして渡す値です。

dwServiceFlagsXP_PSEUDO_STREAM が設定されている場合、アプリケーションは iSocketType の値に関係なく、 sockettype パラメーターに SOCK_STREAM を指定できることに注意してください。

iProtocolINT4+20+20プロトコル用のソケットを開くために socket 関数を呼び出す際に、protocol パラメーターとして渡す値です。
dwMessageSizeDWORD4+24+24

プロトコルがサポートする最大メッセージサイズ(バイト単位)です。これは、ホストが送信または受信できるメッセージの最大サイズです。メッセージフレーミングをサポートしないプロトコルでは、特定のアドレスに送信できるメッセージの実際の最大サイズはこの値より小さくなる場合があります。

次の特殊なメッセージサイズ値が定義されています。

意味
0
プロトコルはストリーム指向であり、メッセージサイズという概念は関係ありません。
0xFFFFFFFF
プロトコルはメッセージ指向ですが、最大メッセージサイズの制限はありません。
lpProtocolLPSTR8/4+32+28プロトコルの名前を提供するゼロ終端文字列へのポインターです。例: "SPX2."

公式ドキュメント

PROTOCOL_INFO 構造体は、プロトコルに関する情報を格納します。

解説(Remarks)

メモ

nspapi.h ヘッダーは、UNICODE プリプロセッサー定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして PROTOCOL_INFO を定義しています。エンコーディング中立のエイリアスを、エンコーディング中立でないコードと混在させて使用すると、不一致が生じてコンパイルエラーまたは実行時エラーの原因となる場合があります。詳細については、「Conventions for Function Prototypes」を参照してください。

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

各言語での定義

#include <windows.h>

// PROTOCOL_INFOA  (x64 40 / x86 32 バイト)
typedef struct PROTOCOL_INFOA {
    DWORD dwServiceFlags;
    INT iAddressFamily;
    INT iMaxSockAddr;
    INT iMinSockAddr;
    INT iSocketType;
    INT iProtocol;
    DWORD dwMessageSize;
    LPSTR lpProtocol;
} PROTOCOL_INFOA;
using System;
using System.Runtime.InteropServices;

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct PROTOCOL_INFOA
{
    public uint dwServiceFlags;
    public int iAddressFamily;
    public int iMaxSockAddr;
    public int iMinSockAddr;
    public int iSocketType;
    public int iProtocol;
    public uint dwMessageSize;
    public IntPtr lpProtocol;
}
Imports System.Runtime.InteropServices

<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure PROTOCOL_INFOA
    Public dwServiceFlags As UInteger
    Public iAddressFamily As Integer
    Public iMaxSockAddr As Integer
    Public iMinSockAddr As Integer
    Public iSocketType As Integer
    Public iProtocol As Integer
    Public dwMessageSize As UInteger
    Public lpProtocol As IntPtr
End Structure
import ctypes
from ctypes import wintypes

class PROTOCOL_INFOA(ctypes.Structure):
    _fields_ = [
        ("dwServiceFlags", wintypes.DWORD),
        ("iAddressFamily", ctypes.c_int),
        ("iMaxSockAddr", ctypes.c_int),
        ("iMinSockAddr", ctypes.c_int),
        ("iSocketType", ctypes.c_int),
        ("iProtocol", ctypes.c_int),
        ("dwMessageSize", wintypes.DWORD),
        ("lpProtocol", ctypes.c_void_p),
    ]
#[repr(C)]
pub struct PROTOCOL_INFOA {
    pub dwServiceFlags: u32,
    pub iAddressFamily: i32,
    pub iMaxSockAddr: i32,
    pub iMinSockAddr: i32,
    pub iSocketType: i32,
    pub iProtocol: i32,
    pub dwMessageSize: u32,
    pub lpProtocol: *mut core::ffi::c_void,
}
import "golang.org/x/sys/windows"

type PROTOCOL_INFOA struct {
	dwServiceFlags uint32
	iAddressFamily int32
	iMaxSockAddr int32
	iMinSockAddr int32
	iSocketType int32
	iProtocol int32
	dwMessageSize uint32
	lpProtocol uintptr
}
type
  PROTOCOL_INFOA = record
    dwServiceFlags: DWORD;
    iAddressFamily: Integer;
    iMaxSockAddr: Integer;
    iMinSockAddr: Integer;
    iSocketType: Integer;
    iProtocol: Integer;
    dwMessageSize: DWORD;
    lpProtocol: Pointer;
  end;
const PROTOCOL_INFOA = extern struct {
    dwServiceFlags: u32,
    iAddressFamily: i32,
    iMaxSockAddr: i32,
    iMinSockAddr: i32,
    iSocketType: i32,
    iProtocol: i32,
    dwMessageSize: u32,
    lpProtocol: ?*anyopaque,
};
type
  PROTOCOL_INFOA {.bycopy.} = object
    dwServiceFlags: uint32
    iAddressFamily: int32
    iMaxSockAddr: int32
    iMinSockAddr: int32
    iSocketType: int32
    iProtocol: int32
    dwMessageSize: uint32
    lpProtocol: pointer
struct PROTOCOL_INFOA
{
    uint dwServiceFlags;
    int iAddressFamily;
    int iMaxSockAddr;
    int iMinSockAddr;
    int iSocketType;
    int iProtocol;
    uint dwMessageSize;
    void* lpProtocol;
}

HSP用 定義

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

; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x86 レイアウト)
; PROTOCOL_INFOA サイズ: 32 バイト(x86)
dim st, 8    ; 4byte整数×8(構造体サイズ 32 / 4 切り上げ)
; dwServiceFlags : DWORD (+0, 4byte)  st.0 = 値  /  値 = st.0   (lpoke/lpeek も可)
; iAddressFamily : INT (+4, 4byte)  st.1 = 値  /  値 = st.1   (lpoke/lpeek も可)
; iMaxSockAddr : INT (+8, 4byte)  st.2 = 値  /  値 = st.2   (lpoke/lpeek も可)
; iMinSockAddr : INT (+12, 4byte)  st.3 = 値  /  値 = st.3   (lpoke/lpeek も可)
; iSocketType : INT (+16, 4byte)  st.4 = 値  /  値 = st.4   (lpoke/lpeek も可)
; iProtocol : INT (+20, 4byte)  st.5 = 値  /  値 = st.5   (lpoke/lpeek も可)
; dwMessageSize : DWORD (+24, 4byte)  st.6 = 値  /  値 = st.6   (lpoke/lpeek も可)
; lpProtocol : LPSTR (+28, 4byte)  st.7 = 値  /  値 = st.7   (lpoke/lpeek も可)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x64 レイアウト)
; PROTOCOL_INFOA サイズ: 40 バイト(x64)
dim st, 10    ; 4byte整数×10(構造体サイズ 40 / 4 切り上げ)
; dwServiceFlags : DWORD (+0, 4byte)  st.0 = 値  /  値 = st.0   (lpoke/lpeek も可)
; iAddressFamily : INT (+4, 4byte)  st.1 = 値  /  値 = st.1   (lpoke/lpeek も可)
; iMaxSockAddr : INT (+8, 4byte)  st.2 = 値  /  値 = st.2   (lpoke/lpeek も可)
; iMinSockAddr : INT (+12, 4byte)  st.3 = 値  /  値 = st.3   (lpoke/lpeek も可)
; iSocketType : INT (+16, 4byte)  st.4 = 値  /  値 = st.4   (lpoke/lpeek も可)
; iProtocol : INT (+20, 4byte)  st.5 = 値  /  値 = st.5   (lpoke/lpeek も可)
; dwMessageSize : DWORD (+24, 4byte)  st.6 = 値  /  値 = st.6   (lpoke/lpeek も可)
; lpProtocol : LPSTR (+32, 8byte)  qpoke st,32,値 / qpeek(st,32)  ※IronHSPのみ。3.7/3.8は lpoke st,32,下位 : lpoke st,36,上位
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; IronHSP は NSTRUCT(構造体)をサポート。32bit/64bit どちらでも同じコードで動作します。
#defstruct global PROTOCOL_INFOA
    #field int dwServiceFlags
    #field int iAddressFamily
    #field int iMaxSockAddr
    #field int iMinSockAddr
    #field int iSocketType
    #field int iProtocol
    #field int dwMessageSize
    #field intptr lpProtocol
#endstruct

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