次の方法で共有

GetIpPathEntry 関数

  • [アーティクル]

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

構文

NETIOAPI_API GetIpPathEntry(
  _Inout_ PMIB_IPPATH_ROW Row
);

パラメーター

  • 行 [入力、出力]
    IP パス エントリの MIB_IPPATH_ROW 構造体エントリへのポインター。 正常に返されると、この構造体は IP パス エントリのプロパティで更新されます。

戻り値

GetIpPathEntry は、関数が成功した場合にSTATUS_SUCCESSを返します。

関数が失敗した場合、GetIpPathEntry は次のいずれかのエラー コードを返します。

リターン コード 形容
STATUS_INVALID_PARAMETER

無効なパラメーターが関数に渡されました。 このエラーは、NULL ポインターが Row パラメーターで渡された場合に返されます。Row パラメーターが指す MIB_IPPATH_ROW 構造体の Destination メンバーの si_family メンバーが、AF_INETまたはAF_INET6に設定されていない場合です。 または、MIB_IPPATH_ROW構造体の interfaceLuid メンバーと InterfaceIndex メンバーの両方 指定されていません。 このエラーは、MIB_IPPATH_ROW構造体の ソース メンバーの si_family メンバーが宛先 IP アドレス ファミリと一致せず、送信元 IP アドレスの si_family がAF_UNSPECとして指定されていない場合にも返されます。
STATUS_NOT_FOUND

指定されたインターフェイスが見つかりませんでした。 このエラーは、Row パラメーターが指すMIB_IPPATH_ROW構造体の InterfaceLuid または InterfaceIndex メンバーによって指定されたネットワーク インターフェイスが見つからない場合に返されます。
STATUS_NOT_SUPPORTED

要求はサポートされていません。 このエラーは、ローカル コンピューター上に IPv4 スタックが存在せず、Row パラメーターが指す MIB_IPPATH_ROW 構造体の ソース および Destination メンバーに IPv4 アドレスが指定されている場合に返されます。 または、ローカル コンピューター上に IPv6 スタックがなく、IPv6 アドレスが ソース および Destination メンバーで指定されている場合。
その他の

FormatMessage 関数を使用して、返されたエラーのメッセージ文字列を取得します。

備考

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

入力時に、ドライバーは、Row パラメーターが指すMIB_IPPATH_ROW構造体の次のメンバーを初期化する必要があります。

  • Destination
    有効な IPv4 または IPv6 アドレスとファミリに設定します。

  • ソース
    ソース メンバーで指定されているアドレス ファミリを、Destination メンバーで指定された宛先 IP アドレス ファミリに設定するか、AF_UNSPECに設定します。

  • InterfaceLuid または InterfaceIndex の を する
    これらのメンバーは、前に示した順序で使用されます。 そのため、InterfaceLuid 指定した場合、このメンバーを使用してインターフェイスが決定されます。 InterfaceLuid メンバーに値が設定されていない場合 (このメンバーの値が 0 に設定されました)、インターフェイスを決定するために、InterfaceIndex メンバーが次に使用されます。

出力時に、呼び出しが成功すると、GetIpPathEntry は IP パス エントリの他のプロパティを取得し、Row パラメーターが指すMIB_IPPATH_ROW構造を入力します。

ドライバーは、GetIpPathTable 関数を呼び出して、ローカル コンピューター上の IP パス エントリを列挙できます。

必要条件

ターゲット プラットフォーム

 ユニバーサル

バージョン

Windows Vista 以降のバージョンの Windows オペレーティング システムで使用できます。

ヘッダ

 Netioapi.h (Netioapi.h を含む)

図書館

 Netio.lib

IRQL

< DISPATCH_LEVEL

関連項目

FlushIpPathTableの

GetIpPathTableの

MIB_IPPATH_ROW

MIB_IPPATH_TABLE