SetIpNetEntry2 関数 (netioapi.h)
SetIpNetEntry2 関数は、ローカル コンピューター上の既存の近隣 IP アドレス エントリの物理アドレスを設定します。
構文
IPHLPAPI_DLL_LINKAGE _NETIOAPI_SUCCESS_ NETIOAPI_API SetIpNetEntry2(
[in, out] PMIB_IPNET_ROW2 Row
);
パラメーター
[in, out] Row
近隣 IP アドレス エントリの MIB_IPNET_ROW2 構造体エントリへのポインター。
戻り値
関数が成功した場合、戻り値はNO_ERROR。
関数が失敗した場合、戻り値は次のいずれかのエラー コードになります。
| リターン コード | 説明 |
|---|---|
|
アクセスが拒否されました。 このエラーは、次のようないくつかの条件で返されます。ユーザーがローカル コンピューターに必要な管理特権を持っていないか、アプリケーションが組み込みの管理者 (RunAs 管理者) として拡張シェルで実行されていません。 |
|
無効なパラメーターが関数に渡されました。 Row パラメーターに NULL ポインターが渡され、Row パラメーターが指すMIB_IPNET_ROW2の Address メンバーが有効なユニキャスト、エニーキャスト、またはマルチキャスト IPv4 または IPv6 アドレスに設定されていない場合、Row パラメーターが指すMIB_IPNET_ROW2の PhysicalAddress メンバーと PhysicalAddressLength メンバーが有効な物理アドレスに設定されていない場合、このエラーが返されます。 または、Row パラメーターが指すMIB_IPNET_ROW2の InterfaceLuid メンバーまたは InterfaceIndex メンバーの両方が指定されていません。 このエラーは、ループバック アドレスが Address メンバーで渡された場合にも返されます。 |
|
指定したインターフェイスが見つかりませんでした。 Row パラメーターが指すMIB_IPNET_ROW2の InterfaceLuid メンバーまたは InterfaceIndex メンバーによって指定されたネットワーク インターフェイスが見つからなかった場合、このエラーが返されます。 |
|
要求はサポートされていません。 このエラーは、ローカル コンピューター上に IPv4 スタックがなく、Row パラメーターが指すMIB_IPNET_ROW2の Address メンバーに IPv4 アドレスが指定されている場合、またはローカル コンピューター上に IPv6 スタックがなく、アドレス メンバーに IPv6 アドレスが指定されていない場合に返されます。 |
|
FormatMessage を使用して、返されたエラーのメッセージ文字列を取得します。 |
注釈
SetIpNetEntry2 関数は、Windows Vista 以降で定義されています。
SetIpNetEntry2 関数は、ローカル コンピューター上の既存の近隣 IP アドレス エントリの物理アドレスを設定するために使用されます。
Row パラメーターが指すMIB_IPNET_ROW2構造体の Address メンバーは、有効なユニキャスト、エニーキャスト、またはマルチキャスト IPv4 または IPv6 アドレスとファミリに初期化する必要があります。 Row パラメーターが指すMIB_IPNET_ROW2構造体の PhysicalAddress メンバーと PhysicalAddressLength メンバーは、有効な物理アドレスに初期化する必要があります。 さらに、Row パラメーターを指すMIB_IPNET_ROW2構造体の少なくとも 1 つのメンバーをインターフェイスに初期化する必要があります。 InterfaceLuid または InterfaceIndex。
フィールドは、上記の順序で使用されます。 したがって、 InterfaceLuid が指定されている場合は、このメンバーを使用して、ユニキャスト IP アドレスを追加するインターフェイスを決定します。 InterfaceLuid メンバーに値が設定されていない場合 (このメンバーの値が 0 に設定されました)、InterfaceIndex メンバーが次に使用されてインターフェイスが決定されます。
Row パラメーターが指すMIB_IPNET_ROW2の Address メンバーで渡された IP アドレスが、指定されたインターフェイス上の既存の近隣 IP アドレスでない場合、SetIpNetEntry2 関数は失敗します。
SetIpNetEntry2 関数は、Administrators グループのメンバーとしてログオンしているユーザーのみが呼び出すことができます。 Administrators グループのメンバーではないユーザーによって SetIpNetEntry2 が呼び出された場合、関数呼び出しは失敗し、 ERROR_ACCESS_DENIED が返されます。
SetIpNetEntry2 関数は、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 |