GetTcpTable 関数 (iphlpapi.h)

[アーティクル]
08/24/2023

GetTcpTable 関数は、IPv4 TCP 接続テーブルを取得します。

構文

IPHLPAPI_DLL_LINKAGE ULONG GetTcpTable(
  [out]     PMIB_TCPTABLE TcpTable,
  [in, out] PULONG        SizePointer,
  [in]      BOOL          Order
);

パラメーター

[out] TcpTable

TCP 接続テーブルを MIB_TCPTABLE 構造体として受け取るバッファーへのポインター。

[in, out] SizePointer

入力時に、 pTcpTable パラメーターによって指されるバッファーのサイズをバイト単位で指定します。

出力時に、バッファーが返された接続テーブルを保持するのに十分な大きさでない場合、関数は、このパラメーターを必要なバッファーサイズ (バイト単位) に設定します。

Windows Vista 以降用にリリースされた Windows SDK では、このパラメーターのデータ型が PDWORD と同等の PULONG に変更されます。

[in] Order

TCP 接続テーブルを並べ替える必要があるかどうかを指定するブール値。このパラメーターが TRUE の場合、テーブルは次の順序で並べ替えられます。

ローカル IP アドレス
ローカルポート
リモート IP アドレス
リモートポート

戻り値

関数が成功した場合、戻り値はNO_ERROR。

関数が失敗した場合、戻り値は次のいずれかのエラーコードになります。

リターンコード	説明
ERROR_INSUFFICIENT_BUFFER	pTcpTable パラメーターが指すバッファーの大きさが不十分です。必要なサイズは、pdwSize パラメーターが指す DWORD 変数で返されます。このエラーは、 pTcpTable パラメーターが NULL の場合にも返されます。
ERROR_INVALID_PARAMETER	pdwSize パラメーターが NULL であるか、または GetTcpTable が pdwSize パラメーターによって指すメモリに書き込むことができません。
ERROR_NOT_SUPPORTED	この関数は、ローカルシステムで使用されているオペレーティングシステムではサポートされていません。
STATUS_UNSUCCESSFUL	このリターンコードを受け取った場合は、通常、関数を再度呼び出すことで問題をクリアし、目的の結果を得ることができます。このリターンコードは、システムの負荷が高くなる結果になる可能性があります。たとえば、TCP 接続テーブルのサイズが 3 回連続して 2 つを超えて変更された場合です。
その他	FormatMessage を使用して、返されたエラーのメッセージ文字列を取得します。

解説

Windows Vista 以降用にリリースされた Windows SDK では、GetTcpTable 関数からの戻り値が、DWORD と同等の ULONG のデータ型に変更されます。

例

次の例では、IPv4 の TCP 接続テーブルを取得し、各接続の状態を出力します。

// Need to link with Iphlpapi.lib and Ws2_32.lib
#include <winsock2.h>
#include <ws2tcpip.h>
#include <iphlpapi.h>
#include <stdio.h>

#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_TCPTABLE pTcpTable;
    DWORD dwSize = 0;
    DWORD dwRetVal = 0;

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

    struct in_addr IpAddr;

    int i;

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

    dwSize = sizeof (MIB_TCPTABLE);
// Make an initial call to GetTcpTable to
// get the necessary size into the dwSize variable
    if ((dwRetVal = GetTcpTable(pTcpTable, &dwSize, TRUE)) ==
        ERROR_INSUFFICIENT_BUFFER) {
        FREE(pTcpTable);
        pTcpTable = (MIB_TCPTABLE *) MALLOC(dwSize);
        if (pTcpTable == NULL) {
            printf("Error allocating memory\n");
            return 1;
        }
    }
// Make a second call to GetTcpTable to get
// the actual data we require
    if ((dwRetVal = GetTcpTable(pTcpTable, &dwSize, TRUE)) == NO_ERROR) {
        printf("\tNumber of entries: %d\n", (int) pTcpTable->dwNumEntries);
        for (i = 0; i < (int) pTcpTable->dwNumEntries; i++) {
            IpAddr.S_un.S_addr = (u_long) pTcpTable->table[i].dwLocalAddr;
            strcpy_s(szLocalAddr, sizeof (szLocalAddr), inet_ntoa(IpAddr));
            IpAddr.S_un.S_addr = (u_long) pTcpTable->table[i].dwRemoteAddr;
            strcpy_s(szRemoteAddr, sizeof (szRemoteAddr), inet_ntoa(IpAddr));

            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:
                printf("UNKNOWN dwState value\n");
                break;
            }
            printf("\tTCP[%d] Local Addr: %s\n", i, szLocalAddr);
            printf("\tTCP[%d] Local Port: %d \n", i,
                   ntohs((u_short)pTcpTable->table[i].dwLocalPort));
            printf("\tTCP[%d] Remote Addr: %s\n", i, szRemoteAddr);
            printf("\tTCP[%d] Remote Port: %d\n", i,
                   ntohs((u_short)pTcpTable->table[i].dwRemotePort));
        }
    } else {
        printf("\tGetTcpTable failed with %d\n", dwRetVal);
        FREE(pTcpTable);
        return 1;
    }

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

    return 0;    
}

要件


サポートされている最小のクライアント	Windows 2000 Professional [デスクトップアプリ \|UWP アプリ]
サポートされている最小のサーバー	Windows 2000 Server [デスクトップアプリ \|UWP アプリ]
対象プラットフォーム	Windows
ヘッダー	iphlpapi.h
Library	Iphlpapi.lib
[DLL]	Iphlpapi.dll

GetTcpTable 関数 (iphlpapi.h)

構文

パラメーター

戻り値

解説

例

要件

関連項目

フィードバック

フィードバック

その他のリソース