ホーム › NetworkManagement.IpHelper › SetIpNetEntry

SetIpNetEntry

関数

ARPテーブルの既存エントリを変更する。

DLLIPHLPAPI.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

// IPHLPAPI.dll
#include <windows.h>

DWORD SetIpNetEntry(
    MIB_IPNETROW_LH* pArpEntry
);

パラメーター

名前	型	方向	説明
pArpEntry	MIB_IPNETROW_LH*	in	MIB_IPNETROW 構造体へのポインターです。この構造体内の情報は、変更するエントリと、そのエントリに設定する新しい情報を指定します。呼び出し元はこの構造体のすべてのメンバーに値を指定する必要があります。

戻り値の型: DWORD

公式ドキュメント

SetIpNetEntry 関数は、ローカルコンピューター上の ARP テーブルにある既存の ARP エントリを変更します。

戻り値

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

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

戻り値	説明
ERROR_ACCESS_DENIED	アクセスが拒否されました。このエラーは Windows Vista および Windows Server 2008 において、次のような複数の条件下で返されます。ユーザーがローカルコンピューターで必要な管理者権限を持っていない場合、またはアプリケーションが組み込みの Administrator として昇格したシェル(管理者として実行)で動作していない場合などです。
ERROR_INVALID_PARAMETER	pArpEntry パラメーターが NULL である、SetIpNetEntry が pArpEntry の指すメモリから読み取れない、または MIB_IPNETROW 構造体のメンバーのいずれかが無効です。
ERROR_NOT_SUPPORTED	ローカルコンピューターで IPv4 トランスポートが構成されていません。
Other	返されたエラーに対応するメッセージ文字列を取得するには FormatMessage を使用してください。

解説(Remarks)

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

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

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

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// IPHLPAPI.dll
#include <windows.h>

DWORD SetIpNetEntry(
    MIB_IPNETROW_LH* pArpEntry
);

[DllImport("IPHLPAPI.dll", ExactSpelling = true)]
static extern uint SetIpNetEntry(
    IntPtr pArpEntry   // MIB_IPNETROW_LH*
);

<DllImport("IPHLPAPI.dll", ExactSpelling:=True)>
Public Shared Function SetIpNetEntry(
    pArpEntry As IntPtr   ' MIB_IPNETROW_LH*
) As UInteger
End Function

' pArpEntry : MIB_IPNETROW_LH*
Declare PtrSafe Function SetIpNetEntry Lib "iphlpapi" ( _
    ByVal pArpEntry As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

SetIpNetEntry = ctypes.windll.iphlpapi.SetIpNetEntry
SetIpNetEntry.restype = wintypes.DWORD
SetIpNetEntry.argtypes = [
    ctypes.c_void_p,  # pArpEntry : MIB_IPNETROW_LH*
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('IPHLPAPI.dll')
SetIpNetEntry = Fiddle::Function.new(
  lib['SetIpNetEntry'],
  [
    Fiddle::TYPE_VOIDP,  # pArpEntry : MIB_IPNETROW_LH*
  ],
  -Fiddle::TYPE_INT)

#[link(name = "iphlpapi")]
extern "system" {
    fn SetIpNetEntry(
        pArpEntry: *mut MIB_IPNETROW_LH  // MIB_IPNETROW_LH*
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("IPHLPAPI.dll")]
public static extern uint SetIpNetEntry(IntPtr pArpEntry);
"@
$api = Add-Type -MemberDefinition $sig -Name 'IPHLPAPI_SetIpNetEntry' -Namespace Win32 -PassThru
# $api::SetIpNetEntry(pArpEntry)

#uselib "IPHLPAPI.dll"
#func global SetIpNetEntry "SetIpNetEntry" sptr
; SetIpNetEntry varptr(pArpEntry)   ; 戻り値は stat
; pArpEntry : MIB_IPNETROW_LH* -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "IPHLPAPI.dll"
#cfunc global SetIpNetEntry "SetIpNetEntry" var
; res = SetIpNetEntry(pArpEntry)
; pArpEntry : MIB_IPNETROW_LH* -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "IPHLPAPI.dll"
#cfunc global SetIpNetEntry "SetIpNetEntry" sptr
; res = SetIpNetEntry(varptr(pArpEntry))
; pArpEntry : MIB_IPNETROW_LH* -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。