DeleteIpNetEntry 関数 (iphlpapi.h)

[アーティクル]
02/28/2024

DeleteIpNetEntry 関数は、ローカルコンピューター上の ARP テーブルから ARP エントリを削除します。

構文

IPHLPAPI_DLL_LINKAGE DWORD DeleteIpNetEntry(
  [in] PMIB_IPNETROW pArpEntry
);

パラメーター

[in] pArpEntry

MIB_IPNETROW構造体へのポインター。この構造体の情報は、削除するエントリを指定します。呼び出し元は、この構造体の 少なくとも dwIndex メンバーと dwAddr メンバーの値を指定する必要があります。

戻り値

関数が成功した場合、 関数は NO_ERROR (ゼロ) を返します。

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

リターンコード	説明
ERROR_ACCESS_DENIED	アクセスが拒否されました。このエラーは、Windows Vista および Windows Server 2008 で、次のようないくつかの条件で返されます。ユーザーがローカルコンピューターに必要な管理特権を持っていないか、アプリケーションが組み込みの管理者 (RunAs 管理者) として拡張シェルで実行されていません。
ERROR_INVALID_PARAMETER	入力パラメーターが無効です。アクションは実行されませんでした。このエラーは、pArpEntry パラメーターが NULL であるか、pArpEntry パラメーターが指すMIB_IPNETROW構造体のメンバーが無効な場合に返されます。
ERROR_NOT_SUPPORTED	IPv4 トランスポートがローカルコンピューターで構成されていません。
その他	FormatMessage を使用して、返されたエラーのメッセージ文字列を取得します。

注釈

ARP テーブルを取得するには、 GetIpNetTable 関数を呼び出します。

Windows Vista 以降では、 DeleteIpNetEntry 関数は、Administrators グループのメンバーとしてログオンしているユーザーのみが呼び出すことができます。 Administrators グループのメンバーではないユーザーによって DeleteIpNetEntry が呼び出された場合、関数呼び出しは失敗し、 ERROR_ACCESS_DENIED が返されます。

DeleteIpNetEntry 関数は、Windows Vista 以降のユーザーアカウント制御 (UAC) により失敗する可能性もあります。この関数を含むアプリケーションが、組み込みの Administrator 以外の Administrators グループのメンバーとしてログオンしているユーザーによって実行された場合、 requestedExecutionLevel が requireAdministrator に設定されたマニフェストファイルでアプリケーションがマークされていない限り、この呼び出しは失敗します。アプリケーションにこのマニフェストファイルがない場合、組み込みの Administrator 以外の Administrators グループのメンバーとしてログオンしているユーザーは、この関数を成功させるために、組み込みの Administrator (RunAs 管理者) として拡張シェルでアプリケーションを実行する必要があります。

メモWindows NT 4.0 および Windows 2000 以降では、この関数は特権操作を実行します。この関数を正常に実行するには、呼び出し元が Administrators グループまたは NetworkConfigurationOperators グループのメンバーとしてログオンしている必要があります。

要件

要件	値
サポートされている最小のクライアント	Windows 2000 Professional [デスクトップアプリのみ]
サポートされている最小のサーバー	Windows 2000 Server [デスクトップアプリのみ]
対象プラットフォーム	Windows
ヘッダー	iphlpapi.h
Library	Iphlpapi.lib
[DLL]	Iphlpapi.dll