GetIpPathEntry 関数 (netioapi.h)
GetIpPathEntry 関数は、ローカル コンピューター上の IP パス エントリの情報を取得します。
構文
IPHLPAPI_DLL_LINKAGE _NETIOAPI_SUCCESS_ NETIOAPI_API GetIpPathEntry(
[in, out] PMIB_IPPATH_ROW Row
);
パラメーター
[in, out] Row
IP パス エントリの MIB_IPPATH_ROW 構造体エントリへのポインター。 正常に戻ると、この構造体は IP パス エントリのプロパティで更新されます。
戻り値
関数が成功した場合、戻り値はNO_ERROR。
関数が失敗した場合、戻り値は次のいずれかのエラー コードになります。
| リターン コード | 説明 |
|---|---|
|
指定されたファイルが見つかりません。 Row パラメーターが指すMIB_IPPATH_ROWの InterfaceLuid メンバーまたは InterfaceIndex メンバーによって指定されたネットワーク インターフェイス LUID またはインターフェイス インデックスがローカル コンピューター上の値でない場合、このエラーが返されます。 |
|
パラメーターが正しくありません。 このエラーは、Row パラメーターで NULL ポインターが渡された場合、Row パラメーターが指すMIB_IPPATH_ROWの Destination メンバーのsi_family メンバーがAF_INETまたはAF_INET6に設定されていない場合、または Row パラメーターが指すMIB_IPPATH_ROWの InterfaceLuid メンバーまたは InterfaceIndex メンバーの両方が指定されていない場合に返されます。 Row パラメーターが指すMIB_IPPATH_ROWの Source メンバーのsi_family メンバーが宛先 IP アドレス ファミリと一致せず、ソース IP アドレスのsi_familyがAF_UNSPECとして指定されていない場合にも、このエラーが返されます。 |
|
Element not found. Row パラメーターが指すMIB_IPPATH_ROW構造体の InterfaceLuid メンバーまたは InterfaceIndex メンバーによって指定されたネットワーク インターフェイスが、MIB_IPPATH_ROW構造体の Destination メンバーで指定された IP アドレスとアドレス ファミリと一致しない場合、このエラーが返されます。 |
|
要求はサポートされていません。 このエラーは、ローカル コンピューター上に IPv4 スタックがなく、Row パラメーターが指すMIB_IPPATH_ROWの Source メンバーと Destination メンバーに IPv4 アドレスが指定されている場合に返されます。 このエラーは、ローカル コンピューター上に IPv6 スタックがなく、 Source メンバーと Destination メンバーで IPv6 アドレスが指定されている場合にも返されます。 |
|
FormatMessage を使用して、返されたエラーのメッセージ文字列を取得します。 |
注釈
GetIpPathEntry 関数は、Windows Vista 以降で定義されています。
GetIpPathEntry 関数は、MIB_IPPATH_ROW構造体エントリを取得するために使用されます。
入力時に、Row パラメーターが指すMIB_IPPATH_ROW構造体の Destination メンバーは、有効な IPv4 または IPv6 アドレスとファミリに初期化する必要があります。 MIB_IPPATH_ROW構造体の Source メンバーで指定されたアドレス ファミリは、宛先メンバーで指定された宛先 IP アドレス ファミリと一致するか、Source メンバーのアドレス ファミリを AF_UNSPECとして指定する必要があります。 さらに、Row パラメーターを指すMIB_IPPATH_ROW構造体の少なくとも 1 つのメンバーを初期化する必要があります。 InterfaceLuid または InterfaceIndex。
フィールドは、上記の順序で使用されます。 したがって、 InterfaceLuid が指定されている場合は、このメンバーを使用してインターフェイスが決定されます。 InterfaceLuid メンバーに値が設定されていない場合 (このメンバーの値が 0 に設定されている場合)、InterfaceIndex メンバーを使用してインターフェイスが決定されます。
呼び出しが成功すると、GetIpPathEntry は IP パス エントリの他のプロパティを取得し、Row パラメーターが指すMIB_IPPATH_ROW構造体に入力します。
GetIpPathTable 関数を呼び出して、ローカル コンピューター上の IP パス エントリを列挙できます。
要件
| 要件 | 値 |
|---|---|
| サポートされている最小のクライアント | Windows Vista [デスクトップ アプリのみ] |
| サポートされている最小のサーバー | Windows Server 2008 [デスクトップ アプリのみ] |
| 対象プラットフォーム | Windows |
| ヘッダー | netioapi.h (Iphlpapi.h を含む) |
| Library | Iphlpapi.lib |
| [DLL] | Iphlpapi.dll |