SetIpForwardEntry2 関数 (netioapi.h)

[アーティクル]
03/15/2023

SetIpForwardEntry2 関数は、ローカルコンピューター上の IP ルートエントリのプロパティを設定します。

構文

IPHLPAPI_DLL_LINKAGE _NETIOAPI_SUCCESS_ NETIOAPI_API SetIpForwardEntry2(
  [in] const MIB_IPFORWARD_ROW2 *Route
);

パラメーター

[in] Route

IP ルートエントリの MIB_IPFORWARD_ROW2 構造体エントリへのポインター。 MIB_IPFORWARD_ROW2の DestinationPrefix メンバーは有効な IP 宛先プレフィックスに設定する必要があり、MIB_IPFORWARD_ROW2の NextHop メンバーは有効な IP アドレスファミリと IP アドレスに設定する必要があり、MIB_IPFORWARD_ROW2の InterfaceLuid または InterfaceIndex メンバーを指定する必要があります。

戻り値

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

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

リターンコード	説明
ERROR_ACCESS_DENIED	アクセスが拒否されました。このエラーは、次のようないくつかの条件で返されます。ユーザーがローカルコンピューターで必要な管理特権を持っていないか、アプリケーションが組み込みの管理者 (RunAs 管理者) として拡張シェルで実行されていません。
ERROR_INVALID_PARAMETER	無効なパラメーターが関数に渡されました。このエラーは、Route パラメーターに NULL ポインターが渡された場合、Route パラメーターが指すMIB_IPFORWARD_ROW2の DestinationPrefix メンバーが指定されなかった場合、Route パラメーターが指すMIB_IPFORWARD_ROW2の NextHop メンバーが指定されていない場合、または Route パラメーターが指すMIB_IPFORWARD_ROW2の InterfaceLuid メンバーまたは InterfaceIndex メンバーの両方が返されます。パラメーターが指定されていません。
ERROR_NOT_FOUND	指定したインターフェイスが見つかりませんでした。 Route パラメーターが指すMIB_IPFORWARD_ROW2の InterfaceLuid メンバーまたは InterfaceIndex メンバーによって指定されたネットワークインターフェイスが見つからなかった場合、このエラーが返されます。
その他	FormatMessage を使用して、返されたエラーのメッセージ文字列を取得します。

注釈

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

SetIpForwardEntry2 関数は、ローカルコンピューター上の既存の IP ルートエントリのプロパティを設定するために使用されます。

Route パラメーターが指すMIB_IPFORWARD_ROW2構造体の DestinationPrefix メンバーは、有効な IP アドレスプレフィックスとファミリに初期化する必要があります。 Route パラメーターが指すMIB_IPFORWARD_ROW2構造体の NextHop メンバーは、有効な IP アドレスとファミリに初期化する必要があります。さらに、Route パラメーターを指すMIB_IPFORWARD_ROW2構造体の少なくとも 1 つのメンバーをインターフェイスに初期化する必要があります。 InterfaceLuid または InterfaceIndex。

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

Route パラメーターによって指されるMIB_IPFORWARD_ROW2構造の Metric メンバーで指定されたルート メトリックオフセットは、完全なルートメトリックの一部のみを表します。完全なメトリックは、関連付けられたインターフェイスのMIB_IPINTERFACE_ROW構造の Metric メンバーで指定されたインターフェイスメトリックに追加された、このルートメトリックオフセットの組み合わせです。アプリケーションは、 GetIpInterfaceEntry 関数を呼び出すことによってインターフェイスメトリックを取得できます。

SetIpForwardEntry2 関数が呼び出されると、Row が指すMIB_IPFORWARD_ROW2構造体の Age メンバーと Origin メンバーは無視されます。これらのメンバーはネットワークスタックによって設定され、 SetIpForwardEntry2 関数を使用して変更することはできません。

Route パラメーターが指すMIB_IPFORWARD_ROW2の DestinationPrefix メンバーと NextHop メンバーが、指定されたインターフェイスの IP ルートエントリと一致しない場合、SetIpForwardEntry2 関数は失敗します。

SetIpForwardEntry2 関数は、Administrators グループのメンバーとしてログオンしているユーザーのみが呼び出すことができます。 Administrators グループのメンバーではないユーザーが SetIpForwardEntry2 を呼び出すと、関数呼び出しは失敗し、 ERROR_ACCESS_DENIED が返されます。

SetIpForwardEntry2 関数は、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