CreateIpForwardEntry2
関数シグネチャ
// IPHLPAPI.dll
#include <windows.h>
WIN32_ERROR CreateIpForwardEntry2(
const MIB_IPFORWARD_ROW2* Row
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| Row | MIB_IPFORWARD_ROW2* | in | IP 経路エントリの MIB_IPFORWARD_ROW2 構造体エントリへのポインター。 |
戻り値の型: WIN32_ERROR
公式ドキュメント
ローカルコンピューター上に新しい IP 経路エントリを作成します。
戻り値
関数が成功した場合、戻り値は NO_ERROR です。
関数が失敗した場合、戻り値は次のいずれかのエラーコードになります。
| 戻り値 | 説明 |
|---|---|
| アクセスが拒否されました。このエラーは、次を含むいくつかの条件下で返されます。ユーザーがローカルコンピューター上で必要な管理者権限を持っていない場合、またはアプリケーションが組み込みの Administrator(管理者として実行)としての昇格されたシェルで実行されていない場合です。 | |
| 無効なパラメーターが関数に渡されました。このエラーは、Row パラメーターに NULL ポインターが渡された場合、Row パラメーターが指す MIB_IPFORWARD_ROW2 の DestinationPrefix メンバーが指定されていない場合、Row パラメーターが指す MIB_IPFORWARD_ROW2 の NextHop メンバーが指定されていない場合、または Row パラメーターが指す MIB_IPFORWARD_ROW2 の InterfaceLuid メンバーと InterfaceIndex メンバーの両方が指定されていない場合に返されます。また、MIB_IPFORWARD_ROW2 で指定された PreferredLifetime メンバーが ValidLifetime メンバーより大きい場合、または MIB_IPFORWARD_ROW2 の SitePrefixLength が DestinationPrefix で指定されたプレフィックス長より大きい場合にもこのエラーが返されます。 | |
| 指定されたインターフェイスが見つかりませんでした。このエラーは、Row パラメーターが指す MIB_IPNET_ROW2 の InterfaceLuid メンバーまたは InterfaceIndex メンバーで指定されたネットワークインターフェイスが見つからなかった場合に返されます。 | |
| 要求はサポートされていません。このエラーは、指定されたインターフェイスが経路をサポートしていない場合に返されます。また、ローカルコンピューターに IPv4 スタックが存在せず、Row パラメーターが指す MIB_IPFORWARD_ROW2 の DestinationPrefix メンバーのアドレスファミリーに AF_INET が指定された場合にもこのエラーが返されます。さらに、ローカルコンピューターに IPv6 スタックが存在せず、DestinationPrefix メンバーのアドレスファミリーに AF_INET6 が指定された場合にもこのエラーが返されます。 | |
| オブジェクトはすでに存在します。このエラーは、Row パラメーターが指す MIB_IPFORWARD_ROW2 の DestinationPrefix メンバーが、MIB_IPFORWARD_ROW2 の InterfaceLuid メンバーまたは InterfaceIndex メンバーで指定されたインターフェイス上の既存の IP 経路エントリと重複している場合に返されます。 | |
|
返されたエラーのメッセージ文字列を取得するには、 FormatMessage を使用してください。 |
解説(Remarks)
CreateIpForwardEntry2 関数は Windows Vista 以降で定義されています。
CreateIpForwardEntry2 関数は、ローカルコンピューター上に新しい近隣 IP アドレスエントリを追加するために使用されます。InitializeIpForwardEntry 関数を使用して、 MIB_IPFORWARD_ROW2 構造体エントリのメンバーを既定値で初期化する必要があります。その後、アプリケーションは MIB_IPFORWARD_ROW2 エントリ内で変更したいメンバーを変更し、CreateIpForwardEntry2 関数を呼び出すことができます。
Row パラメーターが指す MIB_IPFORWARD_ROW2 構造体の DestinationPrefix メンバーは、有効な IPv4 または IPv6 アドレスプレフィックスに初期化する必要があります。Row パラメーターが指す MIB_IPFORWARD_ROW2 構造体の NextHop メンバーは、有効な IPv4 または IPv6 アドレスおよびファミリーに初期化する必要があります。さらに、Row パラメーターが指す MIB_IPFORWARD_ROW2 構造体の次のメンバーのうち少なくとも 1 つをインターフェイスに初期化する必要があります。InterfaceLuid または InterfaceIndex です。
これらのフィールドは上記の順序で使用されます。したがって、InterfaceLuid が指定されている場合は、このメンバーを使用して IP 経路エントリを追加するインターフェイスが決定されます。InterfaceLuid メンバーに値が設定されていない場合(このメンバーの値がゼロに設定されている場合)、次に InterfaceIndex メンバーを使用してインターフェイスが決定されます。
Row パラメーターが指す MIB_IPFORWARD_ROW2 構造体の Metric メンバーで指定される経路メトリックオフセットは、完全な経路メトリックの一部のみを表します。完全なメトリックは、この経路メトリックオフセットに、関連するインターフェイスの MIB_IPINTERFACE_ROW 構造体の Metric メンバーで指定されたインターフェイスメトリックを加算したものの組み合わせです。アプリケーションは、GetIpInterfaceEntry 関数を呼び出すことでインターフェイスメトリックを取得できます。
Row が指す MIB_IPFORWARD_ROW2 構造体の Age メンバーと Origin メンバーは、CreateIpForwardEntry2 関数が呼び出されたときに無視されます。これらのメンバーはネットワークスタックによって設定され、CreateIpForwardEntry2 関数を使用して設定することはできません。
Row パラメーターが指す MIB_IPFORWARD_ROW2 の DestinationPrefix メンバーと NextHop メンバーが、InterfaceLuid メンバーまたは InterfaceIndex メンバーで指定されたインターフェイス上の既存の IP 経路エントリと重複している場合、CreateIpForwardEntry2 関数は失敗します。
CreateIpForwardEntry2 関数は、Administrators グループのメンバーとしてログオンしているユーザーのみが呼び出すことができます。Administrators グループのメンバーでないユーザーが CreateIpForwardEntry2 を呼び出した場合、関数呼び出しは失敗し、ERROR_ACCESS_DENIED が返されます。この関数は、Windows Vista 以降のユーザーアカウント制御(UAC)が原因で失敗することもあります。この関数を含むアプリケーションが、組み込みの Administrator 以外の Administrators グループのメンバーとしてログオンしているユーザーによって実行された場合、アプリケーションのマニフェストファイルで requestedExecutionLevel が requireAdministrator に設定されていない限り、この呼び出しは失敗します。アプリケーションにこのマニフェストファイルがない場合、この関数が成功するためには、組み込みの Administrator 以外の Administrators グループのメンバーとしてログオンしているユーザーが、組み込みの Administrator(管理者として実行)としての昇格されたシェルでアプリケーションを実行する必要があります。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// IPHLPAPI.dll
#include <windows.h>
WIN32_ERROR CreateIpForwardEntry2(
const MIB_IPFORWARD_ROW2* Row
);[DllImport("IPHLPAPI.dll", ExactSpelling = true)]
static extern uint CreateIpForwardEntry2(
IntPtr Row // MIB_IPFORWARD_ROW2*
);<DllImport("IPHLPAPI.dll", ExactSpelling:=True)>
Public Shared Function CreateIpForwardEntry2(
Row As IntPtr ' MIB_IPFORWARD_ROW2*
) As UInteger
End Function' Row : MIB_IPFORWARD_ROW2*
Declare PtrSafe Function CreateIpForwardEntry2 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
CreateIpForwardEntry2 = ctypes.windll.iphlpapi.CreateIpForwardEntry2
CreateIpForwardEntry2.restype = wintypes.DWORD
CreateIpForwardEntry2.argtypes = [
ctypes.c_void_p, # Row : MIB_IPFORWARD_ROW2*
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('IPHLPAPI.dll')
CreateIpForwardEntry2 = Fiddle::Function.new(
lib['CreateIpForwardEntry2'],
[
Fiddle::TYPE_VOIDP, # Row : MIB_IPFORWARD_ROW2*
],
-Fiddle::TYPE_INT)#[link(name = "iphlpapi")]
extern "system" {
fn CreateIpForwardEntry2(
Row: *const MIB_IPFORWARD_ROW2 // MIB_IPFORWARD_ROW2*
) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("IPHLPAPI.dll")]
public static extern uint CreateIpForwardEntry2(IntPtr Row);
"@
$api = Add-Type -MemberDefinition $sig -Name 'IPHLPAPI_CreateIpForwardEntry2' -Namespace Win32 -PassThru
# $api::CreateIpForwardEntry2(Row)#uselib "IPHLPAPI.dll"
#func global CreateIpForwardEntry2 "CreateIpForwardEntry2" sptr
; CreateIpForwardEntry2 varptr(Row) ; 戻り値は stat
; Row : MIB_IPFORWARD_ROW2* -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "IPHLPAPI.dll" #cfunc global CreateIpForwardEntry2 "CreateIpForwardEntry2" var ; res = CreateIpForwardEntry2(Row) ; Row : MIB_IPFORWARD_ROW2* -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "IPHLPAPI.dll" #cfunc global CreateIpForwardEntry2 "CreateIpForwardEntry2" sptr ; res = CreateIpForwardEntry2(varptr(Row)) ; Row : MIB_IPFORWARD_ROW2* -> "sptr" ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; WIN32_ERROR CreateIpForwardEntry2(MIB_IPFORWARD_ROW2* Row) #uselib "IPHLPAPI.dll" #cfunc global CreateIpForwardEntry2 "CreateIpForwardEntry2" var ; res = CreateIpForwardEntry2(Row) ; Row : MIB_IPFORWARD_ROW2* -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; WIN32_ERROR CreateIpForwardEntry2(MIB_IPFORWARD_ROW2* Row) #uselib "IPHLPAPI.dll" #cfunc global CreateIpForwardEntry2 "CreateIpForwardEntry2" intptr ; res = CreateIpForwardEntry2(varptr(Row)) ; Row : MIB_IPFORWARD_ROW2* -> "intptr" ; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。
import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
iphlpapi = windows.NewLazySystemDLL("IPHLPAPI.dll")
procCreateIpForwardEntry2 = iphlpapi.NewProc("CreateIpForwardEntry2")
)
// Row (MIB_IPFORWARD_ROW2*)
r1, _, err := procCreateIpForwardEntry2.Call(
uintptr(Row),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // WIN32_ERRORfunction CreateIpForwardEntry2(
Row: Pointer // MIB_IPFORWARD_ROW2*
): DWORD; stdcall;
external 'IPHLPAPI.dll' name 'CreateIpForwardEntry2';result := DllCall("IPHLPAPI\CreateIpForwardEntry2"
, "Ptr", Row ; MIB_IPFORWARD_ROW2*
, "UInt") ; return: WIN32_ERROR●CreateIpForwardEntry2(Row) = DLL("IPHLPAPI.dll", "dword CreateIpForwardEntry2(void*)")
# 呼び出し: CreateIpForwardEntry2(Row)
# Row : MIB_IPFORWARD_ROW2* -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "iphlpapi" fn CreateIpForwardEntry2(
Row: [*c]MIB_IPFORWARD_ROW2 // MIB_IPFORWARD_ROW2*
) callconv(std.os.windows.WINAPI) u32;proc CreateIpForwardEntry2(
Row: ptr MIB_IPFORWARD_ROW2 # MIB_IPFORWARD_ROW2*
): uint32 {.importc: "CreateIpForwardEntry2", stdcall, dynlib: "IPHLPAPI.dll".}pragma(lib, "iphlpapi");
extern(Windows)
uint CreateIpForwardEntry2(
MIB_IPFORWARD_ROW2* Row // MIB_IPFORWARD_ROW2*
);ccall((:CreateIpForwardEntry2, "IPHLPAPI.dll"), stdcall, UInt32,
(Ptr{MIB_IPFORWARD_ROW2},),
Row)
# Row : MIB_IPFORWARD_ROW2* -> Ptr{MIB_IPFORWARD_ROW2}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
uint32_t CreateIpForwardEntry2(
void* Row);
]]
local iphlpapi = ffi.load("iphlpapi")
-- iphlpapi.CreateIpForwardEntry2(Row)
-- Row : MIB_IPFORWARD_ROW2*
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('IPHLPAPI.dll');
const CreateIpForwardEntry2 = lib.func('__stdcall', 'CreateIpForwardEntry2', 'uint32_t', ['void *']);
// CreateIpForwardEntry2(Row)
// Row : MIB_IPFORWARD_ROW2* -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("IPHLPAPI.dll", {
CreateIpForwardEntry2: { parameters: ["pointer"], result: "u32" },
});
// lib.symbols.CreateIpForwardEntry2(Row)
// Row : MIB_IPFORWARD_ROW2* -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
uint32_t CreateIpForwardEntry2(
void* Row);
C, "IPHLPAPI.dll");
// $ffi->CreateIpForwardEntry2(Row);
// Row : MIB_IPFORWARD_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 CreateIpForwardEntry2(
Pointer Row // MIB_IPFORWARD_ROW2*
);
}@[Link("iphlpapi")]
lib LibIPHLPAPI
fun CreateIpForwardEntry2 = CreateIpForwardEntry2(
Row : MIB_IPFORWARD_ROW2* # MIB_IPFORWARD_ROW2*
) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef CreateIpForwardEntry2Native = Uint32 Function(Pointer<Void>);
typedef CreateIpForwardEntry2Dart = int Function(Pointer<Void>);
final CreateIpForwardEntry2 = DynamicLibrary.open('IPHLPAPI.dll')
.lookupFunction<CreateIpForwardEntry2Native, CreateIpForwardEntry2Dart>('CreateIpForwardEntry2');
// Row : MIB_IPFORWARD_ROW2* -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function CreateIpForwardEntry2(
Row: Pointer // MIB_IPFORWARD_ROW2*
): DWORD; stdcall;
external 'IPHLPAPI.dll' name 'CreateIpForwardEntry2';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "CreateIpForwardEntry2"
c_CreateIpForwardEntry2 :: Ptr () -> IO Word32
-- Row : MIB_IPFORWARD_ROW2* -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let createipforwardentry2 =
foreign "CreateIpForwardEntry2"
((ptr void) @-> returning uint32_t)
(* Row : MIB_IPFORWARD_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 ("CreateIpForwardEntry2" create-ip-forward-entry2 :convention :stdcall) :uint32
(row :pointer)) ; MIB_IPFORWARD_ROW2*
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $CreateIpForwardEntry2 = Win32::API::More->new('IPHLPAPI',
'DWORD CreateIpForwardEntry2(LPVOID Row)');
# my $ret = $CreateIpForwardEntry2->Call($Row);
# Row : MIB_IPFORWARD_ROW2* -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
- f CreateIpForwardEntry — IPv4ルーティングテーブルに新しい経路エントリを追加する。
- f DeleteIpForwardEntry2 — IPルーティングテーブルから経路エントリを削除する。
- f GetBestRoute2 — 指定送信元・宛先アドレスに最適な経路と送信元を取得する。
- f GetIpForwardEntry2 — 指定したIP経路エントリの情報を取得する。
- f GetIpForwardTable2 — 指定アドレスファミリのIPルーティングテーブルを取得する。
- f GetIpInterfaceEntry — 指定IPインターフェイスの構成情報を取得する。
- f InitializeIpForwardEntry — IP経路行構造体を既定値で初期化する。
- s MIB_IPFORWARD_TABLE2
- s MIB_IPINTERFACE_ROW
- f NotifyRouteChange2 — IP経路の変更を通知するコールバックを登録する。
- f SetIpForwardEntry2 — 指定したIP経路エントリの内容を設定する。