CreateIpNetEntry
関数シグネチャ
// IPHLPAPI.dll
#include <windows.h>
DWORD CreateIpNetEntry(
MIB_IPNETROW_LH* pArpEntry
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| pArpEntry | MIB_IPNETROW_LH* | in | 新しいエントリの情報を指定する MIB_IPNETROW 構造体へのポインター。呼び出し元はこの構造体のすべてのメンバーに値を指定する必要があります。 |
戻り値の型: DWORD
公式ドキュメント
CreateIpNetEntry 関数は、ローカルコンピューター上の ARP テーブルにアドレス解決プロトコル (ARP) エントリを作成します。
戻り値
関数が成功した場合、NO_ERROR (ゼロ) を返します。
関数が失敗した場合、戻り値は次のいずれかのエラーコードになります。
| 戻り値 | 説明 |
|---|---|
| アクセスが拒否されました。このエラーは、Windows Vista および Windows Server 2008 において、次のような複数の条件下で返されます: ユーザーがローカルコンピューター上で必要な管理者権限を持っていない場合、またはアプリケーションが組み込み Administrator として昇格されたシェル (管理者として実行) で実行されていない場合。 | |
| 入力パラメーターが無効であり、何の処理も行われませんでした。このエラーは、pArpEntry パラメーターが NULL である場合、 MIB_IPNETROW の dwPhysAddrLen メンバーがゼロまたは 8 を超える値に設定されている場合、MIB_IPNETROW 構造体の >dwAddr メンバーが無効な場合、または MIB_IPNETROW 構造体の他のメンバーのいずれかが無効な場合に返されます。 | |
| ローカルコンピューターで IPv4 トランスポートが構成されていません。 | |
|
返されたエラーのメッセージ文字列を取得するには、 FormatMessage を使用してください。 |
解説(Remarks)
既存の ARP エントリを変更するには、 SetIpNetEntry 関数を使用します。ARP テーブルを取得するには、GetIpNetTable 関数を呼び出します。既存の ARP エントリを削除するには、DeleteIpNetEntry を呼び出します。
Windows Vista 以降では、CreateIpNetEntry 関数は Administrators グループのメンバーとしてログオンしているユーザーのみが呼び出せます。Administrators グループのメンバーでないユーザーが CreateIpNetEntry を呼び出した場合、関数呼び出しは失敗し、ERROR_ACCESS_DENIED が返されます。
CreateIpNetEntry 関数は、Windows Vista 以降ではユーザーアカウント制御 (UAC) が原因で失敗することもあります。この関数を含むアプリケーションが、組み込み Administrator 以外の Administrators グループのメンバーとしてログオンしているユーザーによって実行された場合、マニフェストファイルで requestedExecutionLevel が requireAdministrator に設定されていない限り、この呼び出しは失敗します。アプリケーションにこのマニフェストファイルがない場合、組み込み Administrator 以外の Administrators グループのメンバーとしてログオンしているユーザーは、この関数を成功させるために、組み込み Administrator として昇格されたシェル (管理者として実行) でアプリケーションを実行する必要があります。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// IPHLPAPI.dll
#include <windows.h>
DWORD CreateIpNetEntry(
MIB_IPNETROW_LH* pArpEntry
);[DllImport("IPHLPAPI.dll", ExactSpelling = true)]
static extern uint CreateIpNetEntry(
IntPtr pArpEntry // MIB_IPNETROW_LH*
);<DllImport("IPHLPAPI.dll", ExactSpelling:=True)>
Public Shared Function CreateIpNetEntry(
pArpEntry As IntPtr ' MIB_IPNETROW_LH*
) As UInteger
End Function' pArpEntry : MIB_IPNETROW_LH*
Declare PtrSafe Function CreateIpNetEntry 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
CreateIpNetEntry = ctypes.windll.iphlpapi.CreateIpNetEntry
CreateIpNetEntry.restype = wintypes.DWORD
CreateIpNetEntry.argtypes = [
ctypes.c_void_p, # pArpEntry : MIB_IPNETROW_LH*
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('IPHLPAPI.dll')
CreateIpNetEntry = Fiddle::Function.new(
lib['CreateIpNetEntry'],
[
Fiddle::TYPE_VOIDP, # pArpEntry : MIB_IPNETROW_LH*
],
-Fiddle::TYPE_INT)#[link(name = "iphlpapi")]
extern "system" {
fn CreateIpNetEntry(
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 CreateIpNetEntry(IntPtr pArpEntry);
"@
$api = Add-Type -MemberDefinition $sig -Name 'IPHLPAPI_CreateIpNetEntry' -Namespace Win32 -PassThru
# $api::CreateIpNetEntry(pArpEntry)#uselib "IPHLPAPI.dll"
#func global CreateIpNetEntry "CreateIpNetEntry" sptr
; CreateIpNetEntry varptr(pArpEntry) ; 戻り値は stat
; pArpEntry : MIB_IPNETROW_LH* -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "IPHLPAPI.dll" #cfunc global CreateIpNetEntry "CreateIpNetEntry" var ; res = CreateIpNetEntry(pArpEntry) ; pArpEntry : MIB_IPNETROW_LH* -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "IPHLPAPI.dll" #cfunc global CreateIpNetEntry "CreateIpNetEntry" sptr ; res = CreateIpNetEntry(varptr(pArpEntry)) ; pArpEntry : MIB_IPNETROW_LH* -> "sptr" ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; DWORD CreateIpNetEntry(MIB_IPNETROW_LH* pArpEntry) #uselib "IPHLPAPI.dll" #cfunc global CreateIpNetEntry "CreateIpNetEntry" var ; res = CreateIpNetEntry(pArpEntry) ; pArpEntry : MIB_IPNETROW_LH* -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; DWORD CreateIpNetEntry(MIB_IPNETROW_LH* pArpEntry) #uselib "IPHLPAPI.dll" #cfunc global CreateIpNetEntry "CreateIpNetEntry" intptr ; res = CreateIpNetEntry(varptr(pArpEntry)) ; pArpEntry : MIB_IPNETROW_LH* -> "intptr" ; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。
import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
iphlpapi = windows.NewLazySystemDLL("IPHLPAPI.dll")
procCreateIpNetEntry = iphlpapi.NewProc("CreateIpNetEntry")
)
// pArpEntry (MIB_IPNETROW_LH*)
r1, _, err := procCreateIpNetEntry.Call(
uintptr(pArpEntry),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // DWORDfunction CreateIpNetEntry(
pArpEntry: Pointer // MIB_IPNETROW_LH*
): DWORD; stdcall;
external 'IPHLPAPI.dll' name 'CreateIpNetEntry';result := DllCall("IPHLPAPI\CreateIpNetEntry"
, "Ptr", pArpEntry ; MIB_IPNETROW_LH*
, "UInt") ; return: DWORD●CreateIpNetEntry(pArpEntry) = DLL("IPHLPAPI.dll", "dword CreateIpNetEntry(void*)")
# 呼び出し: CreateIpNetEntry(pArpEntry)
# pArpEntry : MIB_IPNETROW_LH* -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "iphlpapi" fn CreateIpNetEntry(
pArpEntry: [*c]MIB_IPNETROW_LH // MIB_IPNETROW_LH*
) callconv(std.os.windows.WINAPI) u32;proc CreateIpNetEntry(
pArpEntry: ptr MIB_IPNETROW_LH # MIB_IPNETROW_LH*
): uint32 {.importc: "CreateIpNetEntry", stdcall, dynlib: "IPHLPAPI.dll".}pragma(lib, "iphlpapi");
extern(Windows)
uint CreateIpNetEntry(
MIB_IPNETROW_LH* pArpEntry // MIB_IPNETROW_LH*
);ccall((:CreateIpNetEntry, "IPHLPAPI.dll"), stdcall, UInt32,
(Ptr{MIB_IPNETROW_LH},),
pArpEntry)
# pArpEntry : MIB_IPNETROW_LH* -> Ptr{MIB_IPNETROW_LH}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
uint32_t CreateIpNetEntry(
void* pArpEntry);
]]
local iphlpapi = ffi.load("iphlpapi")
-- iphlpapi.CreateIpNetEntry(pArpEntry)
-- pArpEntry : MIB_IPNETROW_LH*
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('IPHLPAPI.dll');
const CreateIpNetEntry = lib.func('__stdcall', 'CreateIpNetEntry', 'uint32_t', ['void *']);
// CreateIpNetEntry(pArpEntry)
// pArpEntry : MIB_IPNETROW_LH* -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("IPHLPAPI.dll", {
CreateIpNetEntry: { parameters: ["pointer"], result: "u32" },
});
// lib.symbols.CreateIpNetEntry(pArpEntry)
// pArpEntry : MIB_IPNETROW_LH* -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
uint32_t CreateIpNetEntry(
void* pArpEntry);
C, "IPHLPAPI.dll");
// $ffi->CreateIpNetEntry(pArpEntry);
// pArpEntry : MIB_IPNETROW_LH*
// 構造体/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 CreateIpNetEntry(
Pointer pArpEntry // MIB_IPNETROW_LH*
);
}@[Link("iphlpapi")]
lib LibIPHLPAPI
fun CreateIpNetEntry = CreateIpNetEntry(
pArpEntry : MIB_IPNETROW_LH* # MIB_IPNETROW_LH*
) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef CreateIpNetEntryNative = Uint32 Function(Pointer<Void>);
typedef CreateIpNetEntryDart = int Function(Pointer<Void>);
final CreateIpNetEntry = DynamicLibrary.open('IPHLPAPI.dll')
.lookupFunction<CreateIpNetEntryNative, CreateIpNetEntryDart>('CreateIpNetEntry');
// pArpEntry : MIB_IPNETROW_LH* -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function CreateIpNetEntry(
pArpEntry: Pointer // MIB_IPNETROW_LH*
): DWORD; stdcall;
external 'IPHLPAPI.dll' name 'CreateIpNetEntry';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "CreateIpNetEntry"
c_CreateIpNetEntry :: Ptr () -> IO Word32
-- pArpEntry : MIB_IPNETROW_LH* -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let createipnetentry =
foreign "CreateIpNetEntry"
((ptr void) @-> returning uint32_t)
(* pArpEntry : MIB_IPNETROW_LH* -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library iphlpapi (t "IPHLPAPI.dll"))
(cffi:use-foreign-library iphlpapi)
(cffi:defcfun ("CreateIpNetEntry" create-ip-net-entry :convention :stdcall) :uint32
(p-arp-entry :pointer)) ; MIB_IPNETROW_LH*
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $CreateIpNetEntry = Win32::API::More->new('IPHLPAPI',
'DWORD CreateIpNetEntry(LPVOID pArpEntry)');
# my $ret = $CreateIpNetEntry->Call($pArpEntry);
# pArpEntry : MIB_IPNETROW_LH* -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
- f CreateIpNetEntry2 — 近隣テーブルに新しいIPと物理アドレスの対応を追加する。
- f CreateProxyArpEntry — 指定インターフェイスにプロキシARPエントリを作成する。
- f DeleteIpNetEntry — ARPテーブルから指定エントリを削除する。
- f DeleteProxyArpEntry — 指定したプロキシARPエントリを削除する。
- f FlushIpNetTable — 指定インターフェイスのARPテーブルをすべて消去する。
- f GetIpNetTable — IPv4アドレスと物理アドレスの対応を保持するARPテーブルを取得する。
- f SetIpNetEntry — ARPテーブルの既存エントリを変更する。