次の方法で共有

DeleteIpForwardEntry2 関数

  • [アーティクル]

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

構文

NETIOAPI_API DeleteIpForwardEntry2(
  _In_ const MIB_IPFORWARD_ROW2 *Row
);

パラメーター

  • Row [in]
    IP ルート エントリの MIB_IPFORWARD_ROW2 構造体エントリへのポインター。 正常に戻ると、このエントリは削除されます。

戻り値

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

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

リターン コード 説明
STATUS_INVALID_PARAMETER

その関数に無効なパラメーターが渡された。 このエラーは、Row パラメーターに NULL ポインターが渡された場合、Row パラメーターが指した MIB_IPFORWARD_ROW2 構造体の DestinationPrefix メンバー が指定されなかった場合、MIB_IPFORWARD_ROW2 構造体の NextHop メンバーが指定されなかった場合、または MIB_IPFORWARD_ROW2 構造体の InterfaceLuid メンバーと InterfaceIndex メンバーが両方とも指定されなかった場合に返されます。
STATUS_NOT_FOUND

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

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

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

解説

DeleteIpForwardEntry2 関数は、MIB_IPFORWARD_ROW2 構造体エントリを削除するために使用されます。

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

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

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

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

出力時に、呼び出しが成功すると、 DeleteIpForwardEntry2 は IP ルート エントリを削除します。

DeleteIpForwardEntry2 関数は、Rowパラメーターが指すMIB_IPFORWARD_ROW2構造体のDestinationPrefixメンバーとNextHopメンバーが、InterfaceLuidまたはInterfaceIndex メンバーで指定されているインターフェイス上の既存の IP ルート エントリと一致しない場合に失敗します。

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

要件

対象プラットフォーム

 ユニバーサル

バージョン

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

ヘッダー

 Netioapi.h (Netioapi.h を含む)

ライブラリ

 Netio.lib

IRQL

< DISPATCH_LEVEL

関連項目

CreateIpForwardEntry2

GetBestRoute2

GetIpForwardEntry2

GetIpForwardTable2

InitializeIpForwardEntry

MIB_IPFORWARD_ROW2

MIB_IPFORWARD_TABLE2

NotifyRouteChange2

SetIpForwardEntry2