Win32 API 日本語リファレンス
ホームNetworkManagement.IpHelper › SetIpForwardEntry2

SetIpForwardEntry2

関数
指定したIP経路エントリの内容を設定する。
DLLIPHLPAPI.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

WIN32_ERROR SetIpForwardEntry2(
    const MIB_IPFORWARD_ROW2* Route
);

パラメーター

名前方向説明
RouteMIB_IPFORWARD_ROW2*inIP ルートエントリの MIB_IPFORWARD_ROW2 構造体エントリへのポインター。MIB_IPFORWARD_ROW2DestinationPrefix メンバーには有効な IP 宛先プレフィックスを設定し、MIB_IPFORWARD_ROW2NextHop メンバーには有効な IP アドレスファミリと IP アドレスを設定する必要があります。また、MIB_IPFORWARD_ROW2InterfaceLuid または InterfaceIndex メンバーを指定する必要があります。

戻り値の型: WIN32_ERROR

公式ドキュメント

ローカルコンピューター上の IP ルートエントリのプロパティを設定します。

戻り値

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

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

戻り値コード 説明
ERROR_ACCESS_DENIED
アクセスが拒否されました。このエラーは、次を含むいくつかの条件で返されます。ユーザーがローカルコンピューター上で必要な管理者権限を持っていない場合、またはアプリケーションが組み込みの Administrator(管理者として実行)としての拡張シェルで実行されていない場合です。
ERROR_INVALID_PARAMETER
無効なパラメーターが関数に渡されました。このエラーは、Route パラメーターに NULL ポインターが渡された場合、Route パラメーターが指す MIB_IPFORWARD_ROW2DestinationPrefix メンバーが指定されていない場合、Route パラメーターが指す MIB_IPFORWARD_ROW2NextHop メンバーが指定されていない場合、または Route パラメーターが指す MIB_IPFORWARD_ROW2InterfaceLuidInterfaceIndex の両メンバーが指定されていない場合に返されます。
ERROR_NOT_FOUND
指定されたインターフェイスが見つかりませんでした。このエラーは、Route パラメーターが指す MIB_IPFORWARD_ROW2InterfaceLuid または InterfaceIndex メンバーで指定されたネットワークインターフェイスが見つからなかった場合に返されます。
その他
返されたエラーのメッセージ文字列を取得するには、 FormatMessage を使用してください。

解説(Remarks)

SetIpForwardEntry2 関数は Windows Vista 以降で定義されています。

SetIpForwardEntry2 関数は、ローカルコンピューター上の既存の IP ルートエントリのプロパティを設定するために使用します。

Route パラメーターが指す MIB_IPFORWARD_ROW2 構造体の DestinationPrefix メンバーは、有効な IP アドレスプレフィックスとファミリに初期化する必要があります。Route パラメーターが指す MIB_IPFORWARD_ROW2 構造体の NextHop メンバーは、有効な IP アドレスとファミリに初期化する必要があります。さらに、Route パラメーターが指す MIB_IPFORWARD_ROW2 構造体の次のメンバーのうち、少なくとも 1 つをインターフェイスに初期化する必要があります。InterfaceLuid または InterfaceIndex です。

これらのフィールドは上記の順序で使用されます。したがって、InterfaceLuid が指定されている場合は、このメンバーを使用してユニキャスト IP アドレスを追加するインターフェイスが決定されます。InterfaceLuid メンバーに値が設定されていない場合(このメンバーの値がゼロに設定されている場合)は、次に InterfaceIndex メンバーを使用してインターフェイスが決定されます。

Route パラメーターが指す MIB_IPFORWARD_ROW2 構造体の Metric メンバーで指定されるルートメトリックオフセットは、完全なルートメトリックの一部のみを表します。完全なメトリックは、このルートメトリックオフセットに、関連するインターフェイスの MIB_IPINTERFACE_ROW 構造体の Metric メンバーで指定されるインターフェイスメトリックを加算したものの組み合わせになります。アプリケーションは、GetIpInterfaceEntry 関数を呼び出すことでインターフェイスメトリックを取得できます。

Row が指す MIB_IPFORWARD_ROW2 構造体の Age および Origin メンバーは、SetIpForwardEntry2 関数が呼び出された際に無視されます。これらのメンバーはネットワークスタックによって設定され、SetIpForwardEntry2 関数では変更できません。

Route パラメーターが指す MIB_IPFORWARD_ROW2DestinationPrefix および NextHop メンバーが、指定されたインターフェイス上の IP ルートエントリと一致しない場合、SetIpForwardEntry2 関数は失敗します。

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

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

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

各言語での呼び出し定義

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

WIN32_ERROR SetIpForwardEntry2(
    const MIB_IPFORWARD_ROW2* Route
);
[DllImport("IPHLPAPI.dll", ExactSpelling = true)]
static extern uint SetIpForwardEntry2(
    IntPtr Route   // MIB_IPFORWARD_ROW2*
);
<DllImport("IPHLPAPI.dll", ExactSpelling:=True)>
Public Shared Function SetIpForwardEntry2(
    Route As IntPtr   ' MIB_IPFORWARD_ROW2*
) As UInteger
End Function
' Route : MIB_IPFORWARD_ROW2*
Declare PtrSafe Function SetIpForwardEntry2 Lib "iphlpapi" ( _
    ByVal Route As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SetIpForwardEntry2 = ctypes.windll.iphlpapi.SetIpForwardEntry2
SetIpForwardEntry2.restype = wintypes.DWORD
SetIpForwardEntry2.argtypes = [
    ctypes.c_void_p,  # Route : MIB_IPFORWARD_ROW2*
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('IPHLPAPI.dll')
SetIpForwardEntry2 = Fiddle::Function.new(
  lib['SetIpForwardEntry2'],
  [
    Fiddle::TYPE_VOIDP,  # Route : MIB_IPFORWARD_ROW2*
  ],
  -Fiddle::TYPE_INT)
#[link(name = "iphlpapi")]
extern "system" {
    fn SetIpForwardEntry2(
        Route: *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 SetIpForwardEntry2(IntPtr Route);
"@
$api = Add-Type -MemberDefinition $sig -Name 'IPHLPAPI_SetIpForwardEntry2' -Namespace Win32 -PassThru
# $api::SetIpForwardEntry2(Route)
#uselib "IPHLPAPI.dll"
#func global SetIpForwardEntry2 "SetIpForwardEntry2" sptr
; SetIpForwardEntry2 varptr(Route)   ; 戻り値は stat
; Route : MIB_IPFORWARD_ROW2* -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "IPHLPAPI.dll"
#cfunc global SetIpForwardEntry2 "SetIpForwardEntry2" var
; res = SetIpForwardEntry2(Route)
; Route : MIB_IPFORWARD_ROW2* -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; WIN32_ERROR SetIpForwardEntry2(MIB_IPFORWARD_ROW2* Route)
#uselib "IPHLPAPI.dll"
#cfunc global SetIpForwardEntry2 "SetIpForwardEntry2" var
; res = SetIpForwardEntry2(Route)
; Route : MIB_IPFORWARD_ROW2* -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	iphlpapi = windows.NewLazySystemDLL("IPHLPAPI.dll")
	procSetIpForwardEntry2 = iphlpapi.NewProc("SetIpForwardEntry2")
)

// Route (MIB_IPFORWARD_ROW2*)
r1, _, err := procSetIpForwardEntry2.Call(
	uintptr(Route),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // WIN32_ERROR
function SetIpForwardEntry2(
  Route: Pointer   // MIB_IPFORWARD_ROW2*
): DWORD; stdcall;
  external 'IPHLPAPI.dll' name 'SetIpForwardEntry2';
result := DllCall("IPHLPAPI\SetIpForwardEntry2"
    , "Ptr", Route   ; MIB_IPFORWARD_ROW2*
    , "UInt")   ; return: WIN32_ERROR
●SetIpForwardEntry2(Route) = DLL("IPHLPAPI.dll", "dword SetIpForwardEntry2(void*)")
# 呼び出し: SetIpForwardEntry2(Route)
# Route : MIB_IPFORWARD_ROW2* -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "iphlpapi" fn SetIpForwardEntry2(
    Route: [*c]MIB_IPFORWARD_ROW2 // MIB_IPFORWARD_ROW2*
) callconv(std.os.windows.WINAPI) u32;
proc SetIpForwardEntry2(
    Route: ptr MIB_IPFORWARD_ROW2  # MIB_IPFORWARD_ROW2*
): uint32 {.importc: "SetIpForwardEntry2", stdcall, dynlib: "IPHLPAPI.dll".}
pragma(lib, "iphlpapi");
extern(Windows)
uint SetIpForwardEntry2(
    MIB_IPFORWARD_ROW2* Route   // MIB_IPFORWARD_ROW2*
);
ccall((:SetIpForwardEntry2, "IPHLPAPI.dll"), stdcall, UInt32,
      (Ptr{MIB_IPFORWARD_ROW2},),
      Route)
# Route : MIB_IPFORWARD_ROW2* -> Ptr{MIB_IPFORWARD_ROW2}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t SetIpForwardEntry2(
    void* Route);
]]
local iphlpapi = ffi.load("iphlpapi")
-- iphlpapi.SetIpForwardEntry2(Route)
-- Route : MIB_IPFORWARD_ROW2*
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('IPHLPAPI.dll');
const SetIpForwardEntry2 = lib.func('__stdcall', 'SetIpForwardEntry2', 'uint32_t', ['void *']);
// SetIpForwardEntry2(Route)
// Route : MIB_IPFORWARD_ROW2* -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("IPHLPAPI.dll", {
  SetIpForwardEntry2: { parameters: ["pointer"], result: "u32" },
});
// lib.symbols.SetIpForwardEntry2(Route)
// Route : MIB_IPFORWARD_ROW2* -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t SetIpForwardEntry2(
    void* Route);
C, "IPHLPAPI.dll");
// $ffi->SetIpForwardEntry2(Route);
// Route : 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 SetIpForwardEntry2(
        Pointer Route   // MIB_IPFORWARD_ROW2*
    );
}
@[Link("iphlpapi")]
lib LibIPHLPAPI
  fun SetIpForwardEntry2 = SetIpForwardEntry2(
    Route : 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 SetIpForwardEntry2Native = Uint32 Function(Pointer<Void>);
typedef SetIpForwardEntry2Dart = int Function(Pointer<Void>);
final SetIpForwardEntry2 = DynamicLibrary.open('IPHLPAPI.dll')
    .lookupFunction<SetIpForwardEntry2Native, SetIpForwardEntry2Dart>('SetIpForwardEntry2');
// Route : MIB_IPFORWARD_ROW2* -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SetIpForwardEntry2(
  Route: Pointer   // MIB_IPFORWARD_ROW2*
): DWORD; stdcall;
  external 'IPHLPAPI.dll' name 'SetIpForwardEntry2';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SetIpForwardEntry2"
  c_SetIpForwardEntry2 :: Ptr () -> IO Word32
-- Route : MIB_IPFORWARD_ROW2* -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let setipforwardentry2 =
  foreign "SetIpForwardEntry2"
    ((ptr void) @-> returning uint32_t)
(* Route : 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 ("SetIpForwardEntry2" set-ip-forward-entry2 :convention :stdcall) :uint32
  (route :pointer))   ; MIB_IPFORWARD_ROW2*
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SetIpForwardEntry2 = Win32::API::More->new('IPHLPAPI',
    'DWORD SetIpForwardEntry2(LPVOID Route)');
# my $ret = $SetIpForwardEntry2->Call($Route);
# Route : MIB_IPFORWARD_ROW2* -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

類似 API
公式の関連項目
使用する型