SetIpNetEntry2
関数シグネチャ
// IPHLPAPI.dll
#include <windows.h>
WIN32_ERROR SetIpNetEntry2(
MIB_IPNET_ROW2* Row
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| Row | MIB_IPNET_ROW2* | in | 近隣 IP アドレスエントリの MIB_IPNET_ROW2 構造体エントリへのポインター。 |
戻り値の型: WIN32_ERROR
公式ドキュメント
ローカルコンピューター上の既存の近隣 IP アドレスエントリの物理アドレスを設定します。
戻り値
関数が成功した場合、戻り値は NO_ERROR です。
関数が失敗した場合、戻り値は次のいずれかのエラーコードになります。
| 戻りコード | 説明 |
|---|---|
| アクセスが拒否されました。このエラーは、次のような複数の条件下で返されます。ユーザーがローカルコンピューター上で必要な管理者権限を持っていない場合、またはアプリケーションが組み込みの Administrator(管理者として実行)としての昇格されたシェルで実行されていない場合などです。 | |
| 無効なパラメーターが関数に渡されました。このエラーは、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 スタックが存在しないにもかかわらず、Address メンバーに IPv6 アドレスが指定された場合に返されます。 | |
|
返されたエラーのメッセージ文字列を取得するには、 FormatMessage を使用してください。 |
解説(Remarks)
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 メンバーに値が設定されていない場合(このメンバーの値がゼロに設定されている場合)、次に 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(管理者として実行)としての昇格されたシェルでアプリケーションを実行する必要があります。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// IPHLPAPI.dll
#include <windows.h>
WIN32_ERROR SetIpNetEntry2(
MIB_IPNET_ROW2* Row
);[DllImport("IPHLPAPI.dll", ExactSpelling = true)]
static extern uint SetIpNetEntry2(
IntPtr Row // MIB_IPNET_ROW2*
);<DllImport("IPHLPAPI.dll", ExactSpelling:=True)>
Public Shared Function SetIpNetEntry2(
Row As IntPtr ' MIB_IPNET_ROW2*
) As UInteger
End Function' Row : MIB_IPNET_ROW2*
Declare PtrSafe Function SetIpNetEntry2 Lib "iphlpapi" ( _
ByVal Row As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
SetIpNetEntry2 = ctypes.windll.iphlpapi.SetIpNetEntry2
SetIpNetEntry2.restype = wintypes.DWORD
SetIpNetEntry2.argtypes = [
ctypes.c_void_p, # Row : MIB_IPNET_ROW2*
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('IPHLPAPI.dll')
SetIpNetEntry2 = Fiddle::Function.new(
lib['SetIpNetEntry2'],
[
Fiddle::TYPE_VOIDP, # Row : MIB_IPNET_ROW2*
],
-Fiddle::TYPE_INT)#[link(name = "iphlpapi")]
extern "system" {
fn SetIpNetEntry2(
Row: *mut MIB_IPNET_ROW2 // MIB_IPNET_ROW2*
) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("IPHLPAPI.dll")]
public static extern uint SetIpNetEntry2(IntPtr Row);
"@
$api = Add-Type -MemberDefinition $sig -Name 'IPHLPAPI_SetIpNetEntry2' -Namespace Win32 -PassThru
# $api::SetIpNetEntry2(Row)#uselib "IPHLPAPI.dll"
#func global SetIpNetEntry2 "SetIpNetEntry2" sptr
; SetIpNetEntry2 varptr(Row) ; 戻り値は stat
; Row : MIB_IPNET_ROW2* -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "IPHLPAPI.dll" #cfunc global SetIpNetEntry2 "SetIpNetEntry2" var ; res = SetIpNetEntry2(Row) ; Row : MIB_IPNET_ROW2* -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "IPHLPAPI.dll" #cfunc global SetIpNetEntry2 "SetIpNetEntry2" sptr ; res = SetIpNetEntry2(varptr(Row)) ; Row : MIB_IPNET_ROW2* -> "sptr" ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; WIN32_ERROR SetIpNetEntry2(MIB_IPNET_ROW2* Row) #uselib "IPHLPAPI.dll" #cfunc global SetIpNetEntry2 "SetIpNetEntry2" var ; res = SetIpNetEntry2(Row) ; Row : MIB_IPNET_ROW2* -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; WIN32_ERROR SetIpNetEntry2(MIB_IPNET_ROW2* Row) #uselib "IPHLPAPI.dll" #cfunc global SetIpNetEntry2 "SetIpNetEntry2" intptr ; res = SetIpNetEntry2(varptr(Row)) ; Row : MIB_IPNET_ROW2* -> "intptr" ; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。
import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
iphlpapi = windows.NewLazySystemDLL("IPHLPAPI.dll")
procSetIpNetEntry2 = iphlpapi.NewProc("SetIpNetEntry2")
)
// Row (MIB_IPNET_ROW2*)
r1, _, err := procSetIpNetEntry2.Call(
uintptr(Row),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // WIN32_ERRORfunction SetIpNetEntry2(
Row: Pointer // MIB_IPNET_ROW2*
): DWORD; stdcall;
external 'IPHLPAPI.dll' name 'SetIpNetEntry2';result := DllCall("IPHLPAPI\SetIpNetEntry2"
, "Ptr", Row ; MIB_IPNET_ROW2*
, "UInt") ; return: WIN32_ERROR●SetIpNetEntry2(Row) = DLL("IPHLPAPI.dll", "dword SetIpNetEntry2(void*)")
# 呼び出し: SetIpNetEntry2(Row)
# Row : MIB_IPNET_ROW2* -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "iphlpapi" fn SetIpNetEntry2(
Row: [*c]MIB_IPNET_ROW2 // MIB_IPNET_ROW2*
) callconv(std.os.windows.WINAPI) u32;proc SetIpNetEntry2(
Row: ptr MIB_IPNET_ROW2 # MIB_IPNET_ROW2*
): uint32 {.importc: "SetIpNetEntry2", stdcall, dynlib: "IPHLPAPI.dll".}pragma(lib, "iphlpapi");
extern(Windows)
uint SetIpNetEntry2(
MIB_IPNET_ROW2* Row // MIB_IPNET_ROW2*
);ccall((:SetIpNetEntry2, "IPHLPAPI.dll"), stdcall, UInt32,
(Ptr{MIB_IPNET_ROW2},),
Row)
# Row : MIB_IPNET_ROW2* -> Ptr{MIB_IPNET_ROW2}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
uint32_t SetIpNetEntry2(
void* Row);
]]
local iphlpapi = ffi.load("iphlpapi")
-- iphlpapi.SetIpNetEntry2(Row)
-- Row : MIB_IPNET_ROW2*
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('IPHLPAPI.dll');
const SetIpNetEntry2 = lib.func('__stdcall', 'SetIpNetEntry2', 'uint32_t', ['void *']);
// SetIpNetEntry2(Row)
// Row : MIB_IPNET_ROW2* -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("IPHLPAPI.dll", {
SetIpNetEntry2: { parameters: ["pointer"], result: "u32" },
});
// lib.symbols.SetIpNetEntry2(Row)
// Row : MIB_IPNET_ROW2* -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
uint32_t SetIpNetEntry2(
void* Row);
C, "IPHLPAPI.dll");
// $ffi->SetIpNetEntry2(Row);
// Row : MIB_IPNET_ROW2*
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;
public interface Iphlpapi extends StdCallLibrary {
Iphlpapi INSTANCE = Native.load("iphlpapi", Iphlpapi.class);
int SetIpNetEntry2(
Pointer Row // MIB_IPNET_ROW2*
);
}@[Link("iphlpapi")]
lib LibIPHLPAPI
fun SetIpNetEntry2 = SetIpNetEntry2(
Row : MIB_IPNET_ROW2* # MIB_IPNET_ROW2*
) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef SetIpNetEntry2Native = Uint32 Function(Pointer<Void>);
typedef SetIpNetEntry2Dart = int Function(Pointer<Void>);
final SetIpNetEntry2 = DynamicLibrary.open('IPHLPAPI.dll')
.lookupFunction<SetIpNetEntry2Native, SetIpNetEntry2Dart>('SetIpNetEntry2');
// Row : MIB_IPNET_ROW2* -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function SetIpNetEntry2(
Row: Pointer // MIB_IPNET_ROW2*
): DWORD; stdcall;
external 'IPHLPAPI.dll' name 'SetIpNetEntry2';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "SetIpNetEntry2"
c_SetIpNetEntry2 :: Ptr () -> IO Word32
-- Row : MIB_IPNET_ROW2* -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let setipnetentry2 =
foreign "SetIpNetEntry2"
((ptr void) @-> returning uint32_t)
(* Row : MIB_IPNET_ROW2* -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library iphlpapi (t "IPHLPAPI.dll"))
(cffi:use-foreign-library iphlpapi)
(cffi:defcfun ("SetIpNetEntry2" set-ip-net-entry2 :convention :stdcall) :uint32
(row :pointer)) ; MIB_IPNET_ROW2*
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $SetIpNetEntry2 = Win32::API::More->new('IPHLPAPI',
'DWORD SetIpNetEntry2(LPVOID Row)');
# my $ret = $SetIpNetEntry2->Call($Row);
# Row : MIB_IPNET_ROW2* -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
- f SetIpNetEntry — ARPテーブルの既存エントリを変更する。
- f CreateIpNetEntry2 — 近隣テーブルに新しいIPと物理アドレスの対応を追加する。
- f DeleteIpNetEntry2 — 近隣テーブルから指定エントリを削除する。
- f FlushIpNetTable2 — 指定アドレスファミリ・インターフェイスの近隣テーブルを消去する。
- f GetIpNetEntry2 — 指定した近隣(IP-物理アドレス)エントリの情報を取得する。
- f GetIpNetTable2 — 指定アドレスファミリの近隣(ARP/NDP)テーブルを取得する。
- s MIB_IPNET_TABLE2
- f ResolveIpNetEntry2 — 指定IPアドレスの物理アドレスを解決し近隣エントリに格納する。