GetTcp6Table2 関数 (iphlpapi.h)

GetTcp6Table2 関数は、IPv6 の TCP 接続テーブルを取得します。

構文

IPHLPAPI_DLL_LINKAGE ULONG GetTcp6Table2(
  [out]     PMIB_TCP6TABLE2 TcpTable,
  [in, out] PULONG          SizePointer,
  [in]      BOOL            Order
);

パラメーター

[out] TcpTable

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

[in, out] SizePointer

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

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

[in] Order

TCP 接続テーブルを並べ替える必要があるかどうかを示す 値。 このパラメーターが TRUE の場合、テーブルは、最も低いローカル IP アドレスから始まる昇順で並べ替えられます。 このパラメーターが FALSE の場合、テーブルは取得された順序で表示されます。

TCP エンドポイントを並べ替えるときに、次の値が比較されます (一覧に示すように)。

  1. ローカル IPv6 アドレス
  2. ローカル スコープ ID
  3. ローカル ポート
  4. リモート IPv6 アドレス
  5. リモート スコープ ID
  6. リモート ポート

戻り値

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

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

リターン コード 説明
ERROR_INSUFFICIENT_BUFFER
TcpTable パラメーターが指すバッファーの大きさが不十分です。 SizePointer パラメーターが指す変数に、必要なサイズが返されます。
ERROR_INVALID_PARAMETER
SizePointer パラメーターが NULL であるか、GetTcp6Table2SizePointer パラメーターによって指すメモリに書き込むことができません。
ERROR_NOT_SUPPORTED
この関数は、ローカル システムで使用されているオペレーティング システムではサポートされていません。
その他
FormatMessage を使用して、返されたエラーのメッセージ文字列を取得します。

解説

GetTcp6Table2 関数は、Windows Vista 以降で定義されています。

GetTcp6Table2 関数は、TCP 接続の TCP オフロード状態に関する情報も取得する GetTcp6Table 関数の拡張バージョンです。

要件

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

関連項目

GetExtendedTcpTable

GetOwnerModuleFromTcp6Entry

GetTcp6Table

GetTcpStatisticsEx

GetTcpTable

MIB_TCP6ROW

MIB_TCP6ROW2

MIB_TCP6ROW_OWNER_MODULE

MIB_TCP6ROW_OWNER_PID

MIB_TCP6TABLE

MIB_TCP6TABLE2

MIB_TCP6TABLE_OWNER_MODULE

MIB_TCP6TABLE_OWNER_PID