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

SetIpInterfaceEntry

関数
指定IPインターフェイスの構成情報を設定する。
DLLIPHLPAPI.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

WIN32_ERROR SetIpInterfaceEntry(
    MIB_IPINTERFACE_ROW* Row
);

パラメーター

名前方向説明
RowMIB_IPINTERFACE_ROW*inoutインターフェイスの MIB_IPINTERFACE_ROW 構造体エントリへのポインター。入力時には、MIB_IPINTERFACE_ROWFamily メンバーを AF_INET6 または AF_INET に設定し、MIB_IPINTERFACE_ROWInterfaceLuid または InterfaceIndex メンバーを指定する必要があります。正常に復帰した場合、MIB_IPINTERFACE_ROW エントリの InterfaceIndex メンバーが指定されていれば、MIB_IPINTERFACE_ROWInterfaceLuid メンバーが設定されます。

戻り値の型: WIN32_ERROR

公式ドキュメント

ローカルコンピューター上の IP インターフェイスのプロパティを設定します。

戻り値

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

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

戻り値コード 説明
ERROR_ACCESS_DENIED
アクセスが拒否されました。このエラーは、次を含むいくつかの条件下で返されます。ユーザーがローカルコンピューター上で必要な管理者特権を持っていない場合、またはアプリケーションが組み込み Administrator として昇格されたシェル (RunAs administrator) で実行されていない場合です。
ERROR_FILE_NOT_FOUND
指定されたファイルが見つかりません。このエラーは、Row パラメーターが指す MIB_IPINTERFACE_ROWInterfaceLuid または InterfaceIndex メンバーで指定されたネットワークインターフェイスの LUID またはインターフェイスインデックスが、ローカルマシン上の値でなかった場合に返されます。
ERROR_INVALID_PARAMETER
無効なパラメーターが関数に渡されました。このエラーは、Row パラメーターに NULL ポインターが渡された場合、Row パラメーターが指す MIB_IPINTERFACE_ROWFamily メンバーが AF_INET または AF_INET6 として指定されていなかった場合、または Row パラメーターが指す MIB_IPINTERFACE_ROWInterfaceLuidInterfaceIndex の両メンバーが指定されていなかった場合に返されます。
ERROR_NOT_FOUND
指定されたインターフェイスが見つかりませんでした。このエラーは、Row パラメーターが指す MIB_IPINTERFACE_ROWInterfaceLuid または InterfaceIndex メンバーで指定されたネットワークインターフェイスが、MIB_IPINTERFACE_ROW 構造体の Family メンバーで指定された IP アドレスファミリと一致しない場合に返されます。
その他
返されたエラーのメッセージ文字列を取得するには、 FormatMessage を使用してください。

解説(Remarks)

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

SetIpInterfaceEntry 関数は、既存の IP インターフェイスエントリを変更するために使用します。

入力時には、Row パラメーターが指す MIB_IPINTERFACE_ROW 構造体の Family メンバーを AF_INET または AF_INET6 のいずれかに初期化する必要があります。さらに入力時には、Row パラメーターが指す MIB_IPINTERFACE_ROW 構造体の次のメンバーのうち少なくとも 1 つを初期化する必要があります。InterfaceLuid または InterfaceIndex です。

これらのフィールドは上記の順序で使用されます。したがって、InterfaceLuid が指定されている場合は、このメンバーを使用してインターフェイスが特定されます。InterfaceLuid メンバーに値が設定されていない場合 (このメンバーの値が 0 に設定されている場合) は、次に InterfaceIndex メンバーを使用してインターフェイスが特定されます。

出力時には、InterfaceIndex が指定されていれば、Row パラメーターが指す MIB_IPINTERFACE_ROW 構造体の InterfaceLuid メンバーが設定されます。

Row が指す MIB_IPINTERFACE_ROW 構造体の MaxReassemblySizeMinRouterAdvertisementIntervalMaxRouterAdvertisementIntervalConnectedSupportsWakeUpPatternsSupportsNeighborDiscoverySupportsRouterDiscoveryReachableTimeTransmitOffloadReceiveOffload の各メンバーは、SetIpInterfaceEntry 関数が呼び出された際には無視されます。これらのメンバーはネットワークスタックによって設定されるものであり、SetIpInterfaceEntry 関数を使用して変更することはできません。

アプリケーションは通常、ローカルコンピューター上の IP インターフェイスエントリを取得するために GetIpInterfaceTable 関数を呼び出すか、変更対象の IP インターフェイスエントリのみを取得するために GetIpInterfaceEntry 関数を呼び出します。その後、特定の IP インターフェイスエントリの MIB_IPINTERFACE_ROW 構造体を変更し、その構造体へのポインターを Row パラメーターとして SetIpInterfaceEntry 関数に渡します。ただし IPv4 では、アプリケーションは MIB_IPINTERFACE_ROW 構造体の SitePrefixLength メンバーを変更しようとしてはなりません。IPv4 では、SitePrefixLength メンバーを 0 に設定する必要があります。

既存の IP インターフェイスエントリを変更するもう 1 つの方法は、InitializeIpInterfaceEntry 関数を使用して、 MIB_IPINTERFACE_ROW 構造体エントリのフィールドを既定値で初期化することです。その後、Row パラメーターが指す MIB_IPINTERFACE_ROW 構造体の Family メンバーと、InterfaceIndex または InterfaceLuid メンバーのいずれかを、変更対象の IP インターフェイスに一致するように設定します。次にアプリケーションは、変更したい MIB_IPINTERFACE_ROW エントリの フィールドを変更し、SetIpInterfaceEntry 関数を呼び出します。ただし IPv4 では、アプリケーションは MIB_IPINTERFACE_ROW 構造体の SitePrefixLength メンバーを変更しようとしてはなりません。IPv4 では、SitePrefixLength メンバーを 0 に設定する必要があります。この方法を使用する際には注意が必要です。なぜなら、変更されるすべてのフィールドを特定する唯一の方法は、特定の IP インターフェイスエントリの MIB_IPINTERFACE_ROW のフィールドと、MIB_IPINTERFACE_ROW が既定値に初期化される際に InitializeIpInterfaceEntry 関数によって設定されるフィールドとを比較することだからです。

セキュリティ要件が異なる複数のネットワークへの特権のない同時アクセスは、セキュリティホールを生み出し、特権のないアプリケーションが 2 つのネットワーク間でデータを意図せず中継することを許してしまいます。典型的な例は、仮想プライベートネットワーク (VPN) とインターネットへの同時アクセスです。Windows Server 2003 および Windows XP は弱いホストモデルを使用しており、RAS は他のインターフェイス上のすべての既定ルートのルートメトリックを増加させることで、このような同時アクセスを防ぎます。したがって、すべてのトラフィックは VPN インターフェイスを経由してルーティングされ、他のネットワーク接続が妨げられます。

Windows Vista 以降では、既定で強いホストモデルが使用されます。GetBestRoute2 または GetBestRoute を使用したルート検索で送信元 IP アドレスが指定されている場合、ルート検索は送信元 IP アドレスのインターフェイスに限定されます。潜在的なルートのリストに VPN インターフェイスのルートさえ含まれなくなるため、RAS によるルートメトリックの変更は効果を持たず、インターネットへのトラフィックが許可されます。MIB_IPINTERFACE_ROWDisableDefaultRoutes メンバーは、インターフェイス上での既定ルートの使用を無効化するために使用できます。このメンバーは、VPN クライアントがスプリットトンネリングを必要としない場合に、スプリットトンネリングを制限するためのセキュリティ対策として使用できます。VPN クライアントは、必要に応じて SetIpInterfaceEntry 関数を呼び出して DisableDefaultRoutes メンバーを TRUE に設定できます。VPN クライアントは、GetIpInterfaceEntry 関数を呼び出すことで、DisableDefaultRoutes メンバーの現在の状態を照会できます。

SetIpInterfaceEntry 関数は、Administrators グループのメンバーとしてログオンしているユーザーのみが呼び出すことができます。SetIpInterfaceEntry が Administrators グループのメンバーでないユーザーによって呼び出された場合、関数呼び出しは失敗し、ERROR_ACCESS_DENIED が返されます。この関数は、Windows Vista 以降のユーザーアカウント制御 (UAC) が原因で失敗することもあります。この関数を含むアプリケーションが、組み込み Administrator 以外の Administrators グループのメンバーとしてログオンしているユーザーによって実行された場合、マニフェストファイルで requestedExecutionLevel が requireAdministrator に設定されていない限り、この呼び出しは失敗します。アプリケーションにこのマニフェストファイルがない場合、この関数を成功させるには、組み込み Administrator 以外の Administrators グループのメンバーとしてログオンしているユーザーが、組み込み Administrator として昇格されたシェル (RunAs 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 SetIpInterfaceEntry(
    MIB_IPINTERFACE_ROW* Row
);
[DllImport("IPHLPAPI.dll", ExactSpelling = true)]
static extern uint SetIpInterfaceEntry(
    IntPtr Row   // MIB_IPINTERFACE_ROW* in/out
);
<DllImport("IPHLPAPI.dll", ExactSpelling:=True)>
Public Shared Function SetIpInterfaceEntry(
    Row As IntPtr   ' MIB_IPINTERFACE_ROW* in/out
) As UInteger
End Function
' Row : MIB_IPINTERFACE_ROW* in/out
Declare PtrSafe Function SetIpInterfaceEntry 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

SetIpInterfaceEntry = ctypes.windll.iphlpapi.SetIpInterfaceEntry
SetIpInterfaceEntry.restype = wintypes.DWORD
SetIpInterfaceEntry.argtypes = [
    ctypes.c_void_p,  # Row : MIB_IPINTERFACE_ROW* in/out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('IPHLPAPI.dll')
SetIpInterfaceEntry = Fiddle::Function.new(
  lib['SetIpInterfaceEntry'],
  [
    Fiddle::TYPE_VOIDP,  # Row : MIB_IPINTERFACE_ROW* in/out
  ],
  -Fiddle::TYPE_INT)
#[link(name = "iphlpapi")]
extern "system" {
    fn SetIpInterfaceEntry(
        Row: *mut MIB_IPINTERFACE_ROW  // MIB_IPINTERFACE_ROW* in/out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("IPHLPAPI.dll")]
public static extern uint SetIpInterfaceEntry(IntPtr Row);
"@
$api = Add-Type -MemberDefinition $sig -Name 'IPHLPAPI_SetIpInterfaceEntry' -Namespace Win32 -PassThru
# $api::SetIpInterfaceEntry(Row)
#uselib "IPHLPAPI.dll"
#func global SetIpInterfaceEntry "SetIpInterfaceEntry" sptr
; SetIpInterfaceEntry varptr(Row)   ; 戻り値は stat
; Row : MIB_IPINTERFACE_ROW* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "IPHLPAPI.dll"
#cfunc global SetIpInterfaceEntry "SetIpInterfaceEntry" var
; res = SetIpInterfaceEntry(Row)
; Row : MIB_IPINTERFACE_ROW* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; WIN32_ERROR SetIpInterfaceEntry(MIB_IPINTERFACE_ROW* Row)
#uselib "IPHLPAPI.dll"
#cfunc global SetIpInterfaceEntry "SetIpInterfaceEntry" var
; res = SetIpInterfaceEntry(Row)
; Row : MIB_IPINTERFACE_ROW* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	iphlpapi = windows.NewLazySystemDLL("IPHLPAPI.dll")
	procSetIpInterfaceEntry = iphlpapi.NewProc("SetIpInterfaceEntry")
)

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

extern "iphlpapi" fn SetIpInterfaceEntry(
    Row: [*c]MIB_IPINTERFACE_ROW // MIB_IPINTERFACE_ROW* in/out
) callconv(std.os.windows.WINAPI) u32;
proc SetIpInterfaceEntry(
    Row: ptr MIB_IPINTERFACE_ROW  # MIB_IPINTERFACE_ROW* in/out
): uint32 {.importc: "SetIpInterfaceEntry", stdcall, dynlib: "IPHLPAPI.dll".}
pragma(lib, "iphlpapi");
extern(Windows)
uint SetIpInterfaceEntry(
    MIB_IPINTERFACE_ROW* Row   // MIB_IPINTERFACE_ROW* in/out
);
ccall((:SetIpInterfaceEntry, "IPHLPAPI.dll"), stdcall, UInt32,
      (Ptr{MIB_IPINTERFACE_ROW},),
      Row)
# Row : MIB_IPINTERFACE_ROW* in/out -> Ptr{MIB_IPINTERFACE_ROW}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t SetIpInterfaceEntry(
    void* Row);
]]
local iphlpapi = ffi.load("iphlpapi")
-- iphlpapi.SetIpInterfaceEntry(Row)
-- Row : MIB_IPINTERFACE_ROW* in/out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('IPHLPAPI.dll');
const SetIpInterfaceEntry = lib.func('__stdcall', 'SetIpInterfaceEntry', 'uint32_t', ['void *']);
// SetIpInterfaceEntry(Row)
// Row : MIB_IPINTERFACE_ROW* in/out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("IPHLPAPI.dll", {
  SetIpInterfaceEntry: { parameters: ["pointer"], result: "u32" },
});
// lib.symbols.SetIpInterfaceEntry(Row)
// Row : MIB_IPINTERFACE_ROW* in/out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t SetIpInterfaceEntry(
    void* Row);
C, "IPHLPAPI.dll");
// $ffi->SetIpInterfaceEntry(Row);
// Row : MIB_IPINTERFACE_ROW* in/out
// 構造体/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 SetIpInterfaceEntry(
        Pointer Row   // MIB_IPINTERFACE_ROW* in/out
    );
}
@[Link("iphlpapi")]
lib LibIPHLPAPI
  fun SetIpInterfaceEntry = SetIpInterfaceEntry(
    Row : MIB_IPINTERFACE_ROW*   # MIB_IPINTERFACE_ROW* in/out
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef SetIpInterfaceEntryNative = Uint32 Function(Pointer<Void>);
typedef SetIpInterfaceEntryDart = int Function(Pointer<Void>);
final SetIpInterfaceEntry = DynamicLibrary.open('IPHLPAPI.dll')
    .lookupFunction<SetIpInterfaceEntryNative, SetIpInterfaceEntryDart>('SetIpInterfaceEntry');
// Row : MIB_IPINTERFACE_ROW* in/out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SetIpInterfaceEntry(
  Row: Pointer   // MIB_IPINTERFACE_ROW* in/out
): DWORD; stdcall;
  external 'IPHLPAPI.dll' name 'SetIpInterfaceEntry';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SetIpInterfaceEntry"
  c_SetIpInterfaceEntry :: Ptr () -> IO Word32
-- Row : MIB_IPINTERFACE_ROW* in/out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let setipinterfaceentry =
  foreign "SetIpInterfaceEntry"
    ((ptr void) @-> returning uint32_t)
(* Row : MIB_IPINTERFACE_ROW* in/out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library iphlpapi (t "IPHLPAPI.dll"))
(cffi:use-foreign-library iphlpapi)

(cffi:defcfun ("SetIpInterfaceEntry" set-ip-interface-entry :convention :stdcall) :uint32
  (row :pointer))   ; MIB_IPINTERFACE_ROW* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SetIpInterfaceEntry = Win32::API::More->new('IPHLPAPI',
    'DWORD SetIpInterfaceEntry(LPVOID Row)');
# my $ret = $SetIpInterfaceEntry->Call($Row);
# Row : MIB_IPINTERFACE_ROW* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

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