CreateIpForwardEntry2 関数 (netioapi.h)

[アーティクル]
08/25/2023

CreateIpForwardEntry2 関数は、ローカルコンピューターに新しい IP ルートエントリを作成します。

構文

IPHLPAPI_DLL_LINKAGE _NETIOAPI_SUCCESS_ NETIOAPI_API CreateIpForwardEntry2(
  [in] const MIB_IPFORWARD_ROW2 *Row
);

パラメーター

[in] Row

IP ルートエントリの MIB_IPFORWARD_ROW2 構造体エントリへのポインター。

戻り値

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

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

リターンコード	説明
ERROR_ACCESS_DENIED	アクセスが拒否されました。このエラーは、次のようないくつかの条件で返されます。ユーザーがローカルコンピューターに必要な管理特権を持っていないか、アプリケーションが組み込みの管理者 (RunAs 管理者) として拡張シェルで実行されていません。
ERROR_INVALID_PARAMETER	無効なパラメーターが関数に渡されました。 Row パラメーターで NULL ポインターが渡された場合、Row パラメーターが指すMIB_IPFORWARD_ROW2の DestinationPrefix メンバーが指定されていない場合、Row パラメーターが指すMIB_IPFORWARD_ROW2の NextHop メンバーが指定されていない場合、または Row パラメーターが指すMIB_IPFORWARD_ROW2の InterfaceLuid メンバーまたは InterfaceIndex メンバーの両方が指定されていない場合、このエラーが返されます。パラメーターが指定されていません。このエラーは、MIB_IPFORWARD_ROW2で指定された PreferredLifetime メンバーが ValidLifetime メンバーより大きい場合、またはMIB_IPFORWARD_ROW2の SitePrefixLength が DestinationPrefix で指定されたプレフィックス長よりも大きい場合にも返されます。
ERROR_NOT_FOUND	指定したインターフェイスが見つかりませんでした。 Row パラメーターが指すMIB_IPNET_ROW2の InterfaceLuid メンバーまたは InterfaceIndex メンバーによって指定されたネットワークインターフェイスが見つからなかった場合、このエラーが返されます。
ERROR_NOT_SUPPORTED	要求はサポートされていません。指定されたインターフェイスがルートをサポートしていない場合、このエラーが返されます。このエラーは、ローカルコンピューター上に IPv4 スタックがなく、Row パラメーターが指すMIB_IPFORWARD_ROW2の DestinationPrefix メンバーのアドレスファミリでAF_INETが指定されている場合にも返されます。このエラーは、ローカルコンピューター上に IPv6 スタックがなく、DestinationPrefix メンバーのアドレスファミリにAF_INET6が指定されている場合にも返されます。
ERROR_OBJECT_ALREADY_EXISTS	オブジェクトが既に存在します。 Row パラメーターが指すMIB_IPFORWARD_ROW2の DestinationPrefix メンバーが、MIB_IPFORWARD_ROW2の InterfaceLuid または InterfaceIndex メンバーによって指定されたインターフェイス上の既存の IP ルートエントリの複製である場合、このエラーが返されます。
その他	FormatMessage を使用して、返されたエラーのメッセージ文字列を取得します。

注釈

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

CreateIpForwardEntry2 関数は、ローカルコンピューターに新しい近隣 IP アドレスエントリを追加するために使用されます。 InitializeIpForwardEntry 関数を使用して、MIB_IPFORWARD_ROW2構造体エントリのメンバーを既定値で初期化する必要があります。アプリケーションは、変更する MIB_IPFORWARD_ROW2 エントリのメンバーを変更し、 CreateIpForwardEntry2 関数を呼び出すことができます。

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

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

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

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

Row パラメーターが指すMIB_IPFORWARD_ROW2の DestinationPrefix メンバーと NextHop メンバーが、InterfaceLuid メンバーまたは InterfaceIndex メンバーで指定されたインターフェイス上の既存の IP ルートエントリの複製である場合、CreateIpForwardEntry2 関数は失敗します。

CreateIpForwardEntry2 関数は、Administrators グループのメンバーとしてログオンしているユーザーのみが呼び出すことができます。 Administrators グループのメンバーではないユーザーによって CreateIpForwardEntry2 が呼び出された場合、関数呼び出しは失敗し、 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