GetIpForwardTable2 関数 (netioapi.h)

[アーティクル]
02/29/2024

GetIpForwardTable2 関数は、ローカルコンピューター上の IP ルートエントリを取得します。

構文

IPHLPAPI_DLL_LINKAGE _NETIOAPI_SUCCESS_ NETIOAPI_API GetIpForwardTable2(
  [in]  ADDRESS_FAMILY        Family,
  [out] PMIB_IPFORWARD_TABLE2 *Table
);

パラメーター

[in] Family

取得するアドレスファミリ。

アドレスファミリに使用できる値は、 Winsock2.h ヘッダーファイルに一覧表示されます。 AF_ アドレスファミリ定数とPF_ プロトコルファミリ定数の値は同一であるため ( たとえば、AF_INET と PF_INET)、どちらの定数も使用できます。

Windows Vista 以降でリリースされたWindows SDKでは、ヘッダーファイルのorganizationが変更され、このメンバーに使用できる値は Ws2def.h ヘッダーファイルで定義されています。 Ws2def.h ヘッダーファイルは Winsock2.h に自動的に含まれるので、直接使用しないでください。

現在サポートされている値は 、AF_INET、 AF_INET6、 AF_UNSPECです。

値	意味
AF_UNSPEC 0	アドレスファミリが指定されていません。このパラメーターを指定すると、この関数は IPv4 と IPv6 の両方のエントリを含む IP ルーティングテーブルを返します。
AF_INET 2	インターネットプロトコルバージョン 4 (IPv4) アドレスファミリ。このパラメーターを指定すると、この関数は IPv4 エントリのみを含む IP ルーティングテーブルを返します。
AF_INET6 23	インターネットプロトコルバージョン 6 (IPv6) アドレスファミリ。このパラメーターを指定すると、この関数は IPv6 エントリのみを含む IP ルーティングテーブルを返します。

[out] Table

ローカルコンピューター上の IP ルートエントリのテーブルを含むMIB_IPFORWARD_TABLE2構造体へのポインター。

戻り値

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

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

リターンコード	説明
ERROR_INVALID_PARAMETER	無効なパラメーターが関数に渡されました。このエラーは、Table パラメーターで NULL ポインターが渡された場合、または Family パラメーターが AF_INET、AF_INET6、または AF_UNSPEC として指定されていない場合に返されます。
ERROR_NOT_ENOUGH_MEMORY	操作を完了するために使用できるメモリリソースが不足しています。
ERROR_NOT_FOUND	Family パラメーターで指定されている IP ルートエントリが見つかりませんでした。
ERROR_NOT_SUPPORTED	要求はサポートされていません。このエラーは、ローカルコンピューター上に IPv4 スタックがなく、Family パラメーターにAF_INETが指定されている場合に返されます。このエラーは、ローカルコンピューター上に IPv6 スタックがなく、Family パラメーターに AF_INET6が指定されている場合にも返されます。このエラーは、この関数がサポートされていない Windows のバージョンでも返されます。
その他	FormatMessage を使用して、返されたエラーのメッセージ文字列を取得します。

注釈

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

次に、
GetIpForwardTable2 関数は、ローカルシステム上の IP ルートエントリを列挙し、この情報を MIB_IPFORWARD_TABLE2 構造体で返します。

IP ルートエントリは、Table パラメーターによって指されるバッファー内のMIB_IPFORWARD_TABLE2構造体で返されます。 MIB_IPFORWARD_TABLE2構造体には、IP ルートエントリ数と、各 IP ルートエントリのMIB_IPFORWARD_ROW2構造体の配列が含まれます。これらの返された構造体が不要になったら、 FreeMibTable を呼び出してメモリを解放します。

Family パラメーターは、AF_INET、AF_INET6、またはAF_UNSPECに初期化する必要があります。

Table パラメーターが指す返されるMIB_IPFORWARD_TABLE2構造体には、NumEntries メンバーと、MIB_IPFORWARD_TABLE2 構造体の Table メンバー内の最初のMIB_IPFORWARD_ROW2配列エントリとの間の配置のためのパディングが含まれている場合があることに注意してください。配置のパディングは、 MIB_IPFORWARD_ROW2 配列エントリ間に存在する場合もあります。 MIB_IPFORWARD_ROW2配列エントリへのアクセスでは、埋め込みが存在する可能性があると想定する必要があります。

要件

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