GetIpNetEntry2 関数 (netioapi.h)

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

GetIpNetEntry2 関数は、ローカルコンピューター上の近隣 IP アドレスエントリの情報を取得します。

構文

IPHLPAPI_DLL_LINKAGE _NETIOAPI_SUCCESS_ NETIOAPI_API GetIpNetEntry2(
  [in, out] PMIB_IPNET_ROW2 Row
);

パラメーター

[in, out] Row

近隣 IP アドレスエントリの MIB_IPNET_ROW2 構造体エントリへのポインター。正常に戻ると、この構造体は近隣 IP アドレスのプロパティで更新されます。

戻り値

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

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

リターンコード	説明
ERROR_FILE_NOT_FOUND	指定されたファイルが見つかりません。 Row パラメーターが指すMIB_IPNET_ROW2の InterfaceLuid メンバーまたは InterfaceIndex メンバーによって指定されたネットワークインターフェイス LUID またはインターフェイスインデックスがローカルコンピューター上の値でない場合、このエラーが返されます。
ERROR_INVALID_PARAMETER	無効なパラメーターが関数に渡されました。このエラーは、NULL ポインターが Row パラメーターで渡された場合、Row パラメーターが指すMIB_IPNET_ROW2の Address メンバーが有効な近隣 IPv4 アドレスまたは IPv6 アドレスに設定されていない場合、または Row パラメーターが指すMIB_IPNET_ROW2の InterfaceLuid メンバーまたは InterfaceIndex メンバーの両方が指定されていない場合に返されます。
ERROR_NOT_FOUND	Element not found. Row パラメーターが指すMIB_IPNET_ROW2構造体の InterfaceLuid または InterfaceIndex メンバーによって指定されたネットワークインターフェイスが、MIB_IPNET_ROW2構造体の Address メンバーで指定された近隣 IP アドレスとアドレスファミリと一致しない場合、このエラーが返されます。
ERROR_NOT_SUPPORTED	要求はサポートされていません。このエラーは、ローカルコンピューター上に IPv4 スタックがなく、Row パラメーターが指すMIB_IPNET_ROW2構造体の Address メンバーで IPv4 アドレスが指定されている場合に返されます。このエラーは、ローカルコンピューター上に IPv6 スタックがなく、MIB_IPNET_ROW2構造体の Address メンバーで IPv6 アドレスが指定されている場合にも返されます。
その他	FormatMessage を使用して、返されたエラーのメッセージ文字列を取得します。

注釈

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

GetIpNetEntry2 関数は、MIB_IPNET_ROW2構造体エントリを取得するために使用されます。

入力時に、Row パラメーターが指すMIB_IPNET_ROW2構造体の Address メンバーは、有効な近隣 IPv4 または IPv6 アドレスとファミリに初期化する必要があります。さらに、Row パラメーターを指すMIB_IPNET_ROW2構造体の少なくとも 1 つのメンバーを初期化する必要があります。 InterfaceLuid または InterfaceIndex。

フィールドは、上記の順序で使用されます。したがって、 InterfaceLuid が指定されている場合は、このメンバーを使用してインターフェイスが決定されます。 InterfaceLuid メンバーに値が設定されていない場合 (このメンバーの値が 0 に設定されました)、InterfaceIndex メンバーが次に使用されてインターフェイスが決定されます。

呼び出しが成功すると、GetIpNetEntry2 は近隣 IP アドレスの他のプロパティを取得し、Row パラメーターが指すMIB_IPNET_ROW2構造体に入力します。

GetIpNetTable2 関数を呼び出して、ローカルコンピューター上の近隣 IP アドレスエントリを列挙できます。

要件

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