DeleteIpForwardEntry2 関数 (netioapi.h)
DeleteIpForwardEntry2 関数は、ローカル コンピューター上の IP ルート エントリを削除します。
構文
IPHLPAPI_DLL_LINKAGE _NETIOAPI_SUCCESS_ NETIOAPI_API DeleteIpForwardEntry2(
[in] const MIB_IPFORWARD_ROW2 *Row
);
パラメーター
[in] Row
IP ルート エントリの MIB_IPFORWARD_ROW2 構造体エントリへのポインター。 正常に戻ると、このエントリは削除されます。
戻り値
関数が成功した場合、戻り値はNO_ERROR。
関数が失敗した場合、戻り値は次のいずれかのエラー コードになります。
| リターン コード | 説明 |
|---|---|
|
アクセスが拒否されました。 このエラーは、次のようないくつかの条件で返されます。ユーザーがローカル コンピューターに必要な管理特権を持っていないか、アプリケーションが組み込みの管理者 (RunAs 管理者) として拡張シェルで実行されていません。 |
|
無効なパラメーターが関数に渡されました。 Row パラメーターで NULL ポインターが渡された場合、Row パラメーターが指すMIB_IPFORWARD_ROW2の DestinationPrefix メンバーが指定されていない場合、Row パラメーターが指すMIB_IPFORWARD_ROW2の NextHop メンバーが指定されていない場合、または Row パラメーターが指すMIB_IPFORWARD_ROW2の InterfaceLuid メンバーまたは InterfaceIndex メンバーの両方が指定されていない場合、このエラーが返されます。パラメーターが指定されていません。 |
|
指定したインターフェイスが見つかりませんでした。 Row パラメーターが指すMIB_IPFORWARD_ROW2の InterfaceLuid メンバーまたは InterfaceIndex メンバーによって指定されたネットワーク インターフェイスが見つからなかった場合、このエラーが返されます。 |
|
要求はサポートされていません。 このエラーは、ローカル コンピューター上に IPv4 スタックがなく、Row パラメーターが指すMIB_IPFORWARD_ROW2の Address メンバーに IPv4 アドレスが指定されている場合に返されます。 このエラーは、ローカル コンピューターに IPv6 スタックがなく、 アドレス メンバーに IPv6 アドレスが指定されている場合にも返されます。 |
|
FormatMessage を使用して、返されたエラーのメッセージ文字列を取得します。 |
注釈
DeleteIpForwardEntry2 関数は、Windows Vista 以降で定義されています。
DeleteIpForwardEntry2 関数は、MIB_IPFORWARD_ROW2構造体エントリを削除するために使用されます。
入力時に、Row パラメーターが指すMIB_IPFORWARD_ROW2構造体の DestinationPrefix メンバーは、有効な IPv4 または IPv6 アドレス プレフィックスとファミリに初期化する必要があります。 入力時に、Row パラメーターが指すMIB_IPFORWARD_ROW2構造体の NextHop メンバーは、有効な IPv4 または IPv6 アドレスとファミリに初期化する必要があります。 さらに、Row パラメーターを指すMIB_IPFORWARD_ROW2構造体の少なくとも 1 つのメンバーを初期化する必要があります。 InterfaceLuid または InterfaceIndex。
フィールドは、上記の順序で使用されます。 したがって、 InterfaceLuid が指定されている場合は、このメンバーを使用してインターフェイスが決定されます。 InterfaceLuid メンバーに値が設定されていない場合 (このメンバーの値が 0 に設定されました)、InterfaceIndex メンバーが次に使用されてインターフェイスが決定されます。
呼び出しが成功すると、出力時に DeleteIpForwardEntry2 によって IP ルート エントリが削除されます。
Row パラメーターが指すMIB_IPFORWARD_ROW2の DestinationPrefix メンバーと NextHop メンバーが、InterfaceLuid メンバーまたは InterfaceIndex メンバーで指定されたインターフェイス上の既存の IP ルート エントリと一致しない場合、DeleteIpForwardEntry2 関数は失敗します。
GetIpForwardTable2 関数を呼び出して、ローカル コンピューター上の IP ルート エントリを列挙できます。
DeleteIpForwardEntry2 関数は、Administrators グループのメンバーとしてログオンしているユーザーのみが呼び出すことができます。 Administrators グループのメンバーではないユーザーによって DeleteIpForwardEntry2 が呼び出された場合、関数呼び出しは失敗し、 ERROR_ACCESS_DENIED が返されます。 この関数は、Windows Vista 以降のユーザー アカウント制御 (UAC) が原因で失敗する場合もあります。 この関数を含むアプリケーションが、組み込みの Administrator 以外の Administrators グループのメンバーとしてログオンしているユーザーによって実行された場合、 requestedExecutionLevel が requireAdministrator に設定されたマニフェスト ファイルでアプリケーションがマークされていない限り、この呼び出しは失敗します。 アプリケーションにこのマニフェスト ファイルがない場合、組み込みの Administrator 以外の Administrators グループのメンバーとしてログオンしているユーザーは、この関数を成功させるために、組み込みの Administrator (RunAs 管理者) として拡張シェルでアプリケーションを実行する必要があります。
要件
| 要件 | 値 |
|---|---|
| サポートされている最小のクライアント | Windows Vista [デスクトップ アプリのみ] |
| サポートされている最小のサーバー | Windows Server 2008 [デスクトップ アプリのみ] |
| 対象プラットフォーム | Windows |
| ヘッダー | netioapi.h (Iphlpapi.h を含む) |
| Library | Iphlpapi.lib |
| [DLL] | Iphlpapi.dll |