Win32 API 日本語リファレンス
ホームNetworkManagement.IpHelper › MIB_TCPROW2

MIB_TCPROW2

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

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

フィールド

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

TCP 接続の状態です。このメンバーには、Iprtrmib.h ヘッダーファイルで定義されている値のいずれかを指定できます。

Windows Vista 以降向けにリリースされた Windows SDK では、ヘッダーファイルの構成が変更されています。このメンバーには、Iprtrmib.h ヘッダーファイルではなく Tcpmib.h ヘッダーファイルで定義されている MIB_TCP_STATE 列挙型の値のいずれかを指定できます。なお、Tcpmib.h ヘッダーファイルは Iprtrmib.h に自動的にインクルードされ、Iprtrmib.hIphlpapi.h ヘッダーファイルに自動的にインクルードされます。Tcpmib.h および Iprtrmib.h ヘッダーファイルを直接使用してはいけません。

意味
MIB_TCP_STATE_CLOSED
1
TCP 接続は CLOSED 状態です。これは接続状態がまったく存在しないことを表します。
MIB_TCP_STATE_LISTEN
2
TCP 接続は LISTEN 状態であり、任意のリモート TCP およびポートからの接続要求を待機しています。
MIB_TCP_STATE_SYN_SENT
3
TCP 接続は SYN-SENT 状態であり、接続要求 (SYN パケット) を送信した後、対応する接続要求を待機しています。
MIB_TCP_STATE_SYN_RCVD
4
TCP 接続は SYN-RECEIVED 状態であり、接続要求 (SYN パケット) の受信と送信の両方を行った後、接続要求に対する確認応答を待機しています。
MIB_TCP_STATE_ESTAB
5
TCP 接続は ESTABLISHED 状態であり、これは接続が確立されていることを表します。受信したデータはユーザーに引き渡すことができます。これは TCP 接続のデータ転送フェーズにおける通常の状態です。
MIB_TCP_STATE_FIN_WAIT1
6
TCP 接続は FIN-WAIT-1 状態であり、リモート TCP からの接続終了要求、または以前に送信した接続終了要求に対する確認応答を待機しています。
MIB_TCP_STATE_FIN_WAIT2
7
TCP 接続は FIN-WAIT-1 状態であり、リモート TCP からの接続終了要求を待機しています。
MIB_TCP_STATE_CLOSE_WAIT
8
TCP 接続は CLOSE-WAIT 状態であり、ローカルユーザーからの接続終了要求を待機しています。
MIB_TCP_STATE_CLOSING
9
TCP 接続は CLOSING 状態であり、リモート TCP からの接続終了要求に対する確認応答を待機しています。
MIB_TCP_STATE_LAST_ACK
10
TCP 接続は LAST-ACK 状態であり、以前にリモート TCP へ送信した接続終了要求 (リモート側の接続終了要求に対する確認応答を含みます) に対する確認応答を待機しています。
MIB_TCP_STATE_TIME_WAIT
11
TCP 接続は TIME-WAIT 状態であり、自身の接続終了要求に対する確認応答をリモート TCP が受信したことを確実にするため、十分な時間が経過するのを待機しています。
MIB_TCP_STATE_DELETE_TCB
12
TCP 接続は TCB 削除状態であり、各 TCP エントリの情報を保持するために使用されるデータ構造である伝送制御ブロック (TCB: Transmission Control Block) の削除を表します。
dwLocalAddrDWORD4+4+4ローカルコンピューター上の TCP 接続のローカル IPv4 アドレスです。値が 0 の場合、リスナーが任意のインターフェイスで接続を受け入れられることを示します。
dwLocalPortDWORD4+8+8

ローカルコンピューター上の TCP 接続のローカルポート番号です (ネットワークバイトオーダー)。

IP ポート番号の最大サイズは 16 ビットであるため、下位 16 ビットのみを使用してください。上位 16 ビットには初期化されていないデータが含まれる場合があります。

dwRemoteAddrDWORD4+12+12リモートコンピューター上の TCP 接続の IPv4 アドレスです。dwState メンバーが MIB_TCP_STATE_LISTEN の場合、この値には意味がありません。
dwRemotePortDWORD4+16+16

リモートコンピューター上の TCP 接続のリモートポート番号です (ネットワークバイトオーダー)。dwState メンバーが MIB_TCP_STATE_LISTEN の場合、このメンバーには意味がありません。

IP ポート番号の最大サイズは 16 ビットであるため、下位 16 ビットのみを使用してください。上位 16 ビットには初期化されていないデータが含まれる場合があります。

dwOwningPidDWORD4+20+20この TCP 接続に対してコンテキストバインドを発行したプロセスの PID です。
dwOffloadStateTCP_CONNECTION_OFFLOAD_STATE4+24+24この TCP 接続のオフロード状態です。このパラメーターには、Tcpmib.h ヘッダーで定義されている TCP_CONNECTION_OFFLOAD_STATE の列挙値のいずれかを指定できます。

公式ドキュメント

MIB_TCPROW2 構造体は、IPv4 の TCP 接続を記述する情報を格納します。

解説(Remarks)

GetTcpTable2 関数は、ローカルコンピューター上の IPv4 TCP 接続テーブルを取得し、その情報を MIB_TCPTABLE2 構造体で返します。

MIB_TCPROW2 構造体の配列は、MIB_TCPTABLE2 構造体に格納されます。

dwState メンバーは、TCP 状態遷移図における TCP エントリの状態を示します。TCP 接続はその存続期間中に一連の状態を経て遷移します。状態は次のとおりです: LISTEN、SYN-SENT、SYN-RECEIVED、ESTABLISHED、FIN-WAIT-1、FIN-WAIT-2、CLOSE-WAIT、CLOSING、LAST-ACK、TIME-WAIT、および仮想的な状態である CLOSED。CLOSED 状態が仮想的であるのは、伝送制御ブロックが存在せず、したがって接続も存在しない状態を表すためです。TCP プロトコルは RFC 793 で規定されています。詳細については、http://www.ietf.org/rfc/rfc793.txt を参照してください。

dwLocalPort および dwRemotePort メンバーはネットワークバイトオーダーです。dwLocalPortdwRemotePort メンバーを使用するには、Windows ソケットの ntohs 関数や inet_ntoa 関数、あるいは同様の関数が必要になる場合があります。dwLocalAddr および dwRemoteAddr メンバーは、in_addr 構造体と同じ形式の DWORD として格納されます。dwLocalAddrdwRemoteAddr メンバーを使用するには、Windows ソケットの ntohl 関数や inet_ntoa 関数、あるいは同様の関数が必要になる場合があります。Windows Vista 以降では、RtlIpv4AddressToString 関数または RtlIpv4AddressToStringEx 関数を使用して、Windows ソケット DLL を読み込むことなく dwLocalAddrdwRemoteAddr メンバーの IPv4 アドレスを文字列に変換できます。

次の例では、IPv4 の TCP 接続テーブルを取得し、MIB_TCPROW2 構造体として表される各接続の状態を出力します。

#include <winsock2.h>
#include <ws2tcpip.h>
#include <iphlpapi.h>
#include <stdio.h>

// Need to link with Iphlpapi.lib and Ws2_32.lib
#pragma comment(lib, "iphlpapi.lib")
#pragma comment(lib, "ws2_32.lib")

#define MALLOC(x) HeapAlloc(GetProcessHeap(), 0, (x))
#define FREE(x) HeapFree(GetProcessHeap(), 0, (x))
/* Note: could also use malloc() and free() */

int main()
{

    // Declare and initialize variables
    PMIB_TCPTABLE2 pTcpTable;
    ULONG ulSize = 0;
    DWORD dwRetVal = 0;

    char szLocalAddr[128];
    char szRemoteAddr[128];

    struct in_addr IpAddr;

    int i;

    pTcpTable = (MIB_TCPTABLE2 *) MALLOC(sizeof (MIB_TCPTABLE2));
    if (pTcpTable == NULL) {
        printf("Error allocating memory\n");
        return 1;
    }

    ulSize = sizeof (MIB_TCPTABLE);
// Make an initial call to GetTcpTable2 to
// get the necessary size into the ulSize variable
    if ((dwRetVal = GetTcpTable2(pTcpTable, &ulSize, TRUE)) ==
        ERROR_INSUFFICIENT_BUFFER) {
        FREE(pTcpTable);
        pTcpTable = (MIB_TCPTABLE2 *) MALLOC(ulSize);
        if (pTcpTable == NULL) {
            printf("Error allocating memory\n");
            return 1;
        }
    }
// Make a second call to GetTcpTable2 to get
// the actual data we require
    if ((dwRetVal = GetTcpTable2(pTcpTable, &ulSize, TRUE)) == NO_ERROR) {
        printf("\tNumber of entries: %d\n", (int) pTcpTable->dwNumEntries);
        for (i = 0; i < (int) pTcpTable->dwNumEntries; i++) {
            printf("\n\tTCP[%d] State: %ld - ", i,
                   pTcpTable->table[i].dwState);
            switch (pTcpTable->table[i].dwState) {
            case MIB_TCP_STATE_CLOSED:
                printf("CLOSED\n");
                break;
            case MIB_TCP_STATE_LISTEN:
                printf("LISTEN\n");
                break;
            case MIB_TCP_STATE_SYN_SENT:
                printf("SYN-SENT\n");
                break;
            case MIB_TCP_STATE_SYN_RCVD:
                printf("SYN-RECEIVED\n");
                break;
            case MIB_TCP_STATE_ESTAB:
                printf("ESTABLISHED\n");
                break;
            case MIB_TCP_STATE_FIN_WAIT1:
                printf("FIN-WAIT-1\n");
                break;
            case MIB_TCP_STATE_FIN_WAIT2:
                printf("FIN-WAIT-2 \n");
                break;
            case MIB_TCP_STATE_CLOSE_WAIT:
                printf("CLOSE-WAIT\n");
                break;
            case MIB_TCP_STATE_CLOSING:
                printf("CLOSING\n");
                break;
            case MIB_TCP_STATE_LAST_ACK:
                printf("LAST-ACK\n");
                break;
            case MIB_TCP_STATE_TIME_WAIT:
                printf("TIME-WAIT\n");
                break;
            case MIB_TCP_STATE_DELETE_TCB:
                printf("DELETE-TCB\n");
                break;
            default:
                wprintf(L"UNKNOWN dwState value: %d\n", pTcpTable->table[i].dwState);
                break;
            }

            IpAddr.S_un.S_addr = (u_long) pTcpTable->table[i].dwLocalAddr;
            strcpy_s(szLocalAddr, sizeof (szLocalAddr), inet_ntoa(IpAddr));
            printf("\tTCP[%d] Local Addr: %s\n", i, szLocalAddr);

            printf("\tTCP[%d] Local Port: %d \n", i,
                   ntohs((u_short)pTcpTable->table[i].dwLocalPort));

            IpAddr.S_un.S_addr = (u_long) pTcpTable->table[i].dwRemoteAddr;
            strcpy_s(szRemoteAddr, sizeof (szRemoteAddr), inet_ntoa(IpAddr));
            printf("\tTCP[%d] Remote Addr: %s\n", i, szRemoteAddr);

            printf("\tTCP[%d] Remote Port: %d\n", i,
                   ntohs((u_short)pTcpTable->table[i].dwRemotePort));
                   
            printf("\tTCP[%d] Owning PID: %d\n", i, pTcpTable->table[i].dwOwningPid);

            printf("\tTCP[%d] Offload State: %ld - ", i,
                   pTcpTable->table[i].dwOffloadState);
            switch (pTcpTable->table[i].dwOffloadState) {
            case TcpConnectionOffloadStateInHost:
                printf("Owned by the network stack and not offloaded \n");
                break;
            case TcpConnectionOffloadStateOffloading:
                printf("In the process of being offloaded\n");
                break;
            case TcpConnectionOffloadStateOffloaded:
                printf("Offloaded to the network interface control\n");
                break;
            case TcpConnectionOffloadStateUploading:
                printf("In the process of being uploaded back to the network stack \n");
                break;
            default:
                printf("UNKNOWN Offload state value\n");
                break;
            }
                   
        }
    } else {
        printf("\tGetTcpTable2 failed with %d\n", dwRetVal);
        FREE(pTcpTable);
        return 1;
    }

    if (pTcpTable != NULL) {
        FREE(pTcpTable);
        pTcpTable = NULL;
    }

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

各言語での定義

#include <windows.h>

// MIB_TCPROW2  (x64 28 / x86 28 バイト)
typedef struct MIB_TCPROW2 {
    DWORD dwState;
    DWORD dwLocalAddr;
    DWORD dwLocalPort;
    DWORD dwRemoteAddr;
    DWORD dwRemotePort;
    DWORD dwOwningPid;
    TCP_CONNECTION_OFFLOAD_STATE dwOffloadState;
} MIB_TCPROW2;
using System;
using System.Runtime.InteropServices;

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct MIB_TCPROW2
{
    public uint dwState;
    public uint dwLocalAddr;
    public uint dwLocalPort;
    public uint dwRemoteAddr;
    public uint dwRemotePort;
    public uint dwOwningPid;
    public int dwOffloadState;
}
Imports System.Runtime.InteropServices

<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure MIB_TCPROW2
    Public dwState As UInteger
    Public dwLocalAddr As UInteger
    Public dwLocalPort As UInteger
    Public dwRemoteAddr As UInteger
    Public dwRemotePort As UInteger
    Public dwOwningPid As UInteger
    Public dwOffloadState As Integer
End Structure
import ctypes
from ctypes import wintypes

class MIB_TCPROW2(ctypes.Structure):
    _fields_ = [
        ("dwState", wintypes.DWORD),
        ("dwLocalAddr", wintypes.DWORD),
        ("dwLocalPort", wintypes.DWORD),
        ("dwRemoteAddr", wintypes.DWORD),
        ("dwRemotePort", wintypes.DWORD),
        ("dwOwningPid", wintypes.DWORD),
        ("dwOffloadState", ctypes.c_int),
    ]
#[repr(C)]
pub struct MIB_TCPROW2 {
    pub dwState: u32,
    pub dwLocalAddr: u32,
    pub dwLocalPort: u32,
    pub dwRemoteAddr: u32,
    pub dwRemotePort: u32,
    pub dwOwningPid: u32,
    pub dwOffloadState: i32,
}
import "golang.org/x/sys/windows"

type MIB_TCPROW2 struct {
	dwState uint32
	dwLocalAddr uint32
	dwLocalPort uint32
	dwRemoteAddr uint32
	dwRemotePort uint32
	dwOwningPid uint32
	dwOffloadState int32
}
type
  MIB_TCPROW2 = record
    dwState: DWORD;
    dwLocalAddr: DWORD;
    dwLocalPort: DWORD;
    dwRemoteAddr: DWORD;
    dwRemotePort: DWORD;
    dwOwningPid: DWORD;
    dwOffloadState: Integer;
  end;
const MIB_TCPROW2 = extern struct {
    dwState: u32,
    dwLocalAddr: u32,
    dwLocalPort: u32,
    dwRemoteAddr: u32,
    dwRemotePort: u32,
    dwOwningPid: u32,
    dwOffloadState: i32,
};
type
  MIB_TCPROW2 {.bycopy.} = object
    dwState: uint32
    dwLocalAddr: uint32
    dwLocalPort: uint32
    dwRemoteAddr: uint32
    dwRemotePort: uint32
    dwOwningPid: uint32
    dwOffloadState: int32
struct MIB_TCPROW2
{
    uint dwState;
    uint dwLocalAddr;
    uint dwLocalPort;
    uint dwRemoteAddr;
    uint dwRemotePort;
    uint dwOwningPid;
    int dwOffloadState;
}

HSP用 定義

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

; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x64 レイアウト)
; MIB_TCPROW2 サイズ: 28 バイト(x64)
dim st, 7    ; 4byte整数×7(構造体サイズ 28 / 4 切り上げ)
; dwState : DWORD (+0, 4byte)  st.0 = 値  /  値 = st.0   (lpoke/lpeek も可)
; dwLocalAddr : DWORD (+4, 4byte)  st.1 = 値  /  値 = st.1   (lpoke/lpeek も可)
; dwLocalPort : DWORD (+8, 4byte)  st.2 = 値  /  値 = st.2   (lpoke/lpeek も可)
; dwRemoteAddr : DWORD (+12, 4byte)  st.3 = 値  /  値 = st.3   (lpoke/lpeek も可)
; dwRemotePort : DWORD (+16, 4byte)  st.4 = 値  /  値 = st.4   (lpoke/lpeek も可)
; dwOwningPid : DWORD (+20, 4byte)  st.5 = 値  /  値 = st.5   (lpoke/lpeek も可)
; dwOffloadState : TCP_CONNECTION_OFFLOAD_STATE (+24, 4byte)  st.6 = 値  /  値 = st.6   (lpoke/lpeek も可)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; IronHSP は NSTRUCT(構造体)をサポート。32bit/64bit どちらでも同じコードで動作します。
#defstruct global MIB_TCPROW2
    #field int dwState
    #field int dwLocalAddr
    #field int dwLocalPort
    #field int dwRemoteAddr
    #field int dwRemotePort
    #field int dwOwningPid
    #field int dwOffloadState
#endstruct

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