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

SetUnicastIpAddressEntry

関数
指定したユニキャストIPアドレスエントリを設定する。
DLLIPHLPAPI.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

WIN32_ERROR SetUnicastIpAddressEntry(
    const MIB_UNICASTIPADDRESS_ROW* Row
);

パラメーター

名前方向説明
RowMIB_UNICASTIPADDRESS_ROW*in既存のユニキャスト IP アドレスエントリを表す MIB_UNICASTIPADDRESS_ROW 構造体エントリへのポインター。

戻り値の型: WIN32_ERROR

公式ドキュメント

ローカルコンピューター上の既存のユニキャスト IP アドレスエントリのプロパティを設定します。

戻り値

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

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

戻り値 説明
ERROR_ACCESS_DENIED
アクセスが拒否されました。このエラーは、次のような複数の条件で返されます。すなわち、ユーザーがローカルコンピューター上で必要な管理者権限を持っていない場合、またはアプリケーションが組み込み Administrator(管理者として実行)としての昇格されたシェルで実行されていない場合です。
ERROR_INVALID_PARAMETER
無効なパラメーターが関数に渡されました。このエラーは、Row パラメーターに NULL ポインターが渡された場合、Row パラメーターが指す MIB_UNICASTIPADDRESS_ROWAddress メンバーが有効なユニキャスト IPv4 または IPv6 アドレスに設定されていない場合、または Row パラメーターが指す MIB_UNICASTIPADDRESS_ROWInterfaceLuid メンバーと InterfaceIndex メンバーの両方が指定されていない場合に返されます。

このエラーは、MIB_UNICASTIPADDRESS_ROW 構造体のメンバーに設定された値に関するその他のエラーでも返されます。これらのエラーには次のものが含まれます。すなわち、ValidLifetime メンバーが PreferredLifetime メンバーより小さい場合、PrefixOrigin メンバーが IpPrefixOriginUnchanged に設定されているのに SuffixOriginIpSuffixOriginUnchanged に設定されていない場合、PrefixOrigin メンバーが IpPrefixOriginUnchanged に設定されていないのに SuffixOriginIpSuffixOriginUnchanged に設定されている場合、PrefixOrigin メンバーが NL_PREFIX_ORIGIN 列挙型の値に設定されていない場合、SuffixOrigin メンバーが NL_SUFFIX_ORIGIN 列挙型の値に設定されていない場合、または OnLinkPrefixLength メンバーが IP アドレスのビット長(ユニキャスト IPv4 アドレスの場合は 32、ユニキャスト IPv6 アドレスの場合は 128)より大きい値に設定されている場合です。

ERROR_NOT_FOUND
指定されたインターフェイスが見つかりませんでした。このエラーは、Row パラメーターが指す MIB_UNICASTIPADDRESS_ROWInterfaceLuid または InterfaceIndex メンバーで指定されたネットワークインターフェイスが見つからなかった場合に返されます。
ERROR_NOT_SUPPORTED
要求はサポートされていません。このエラーは、ローカルコンピューターに IPv4 スタックが存在せず、Row パラメーターが指す MIB_UNICASTIPADDRESS_ROWAddress メンバーに IPv4 アドレスが指定された場合、またはローカルコンピューターに IPv6 スタックが存在せず、Address メンバーに IPv6 アドレスが指定された場合に返されます。
その他
返されたエラーのメッセージ文字列を取得するには、 FormatMessage を使用してください。

解説(Remarks)

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

通常、変更対象となる既存の MIB_UNICASTIPADDRESS_ROW 構造体エントリを取得するには、GetUnicastIpAddressEntry 関数を使用します。その後、アプリケーションは MIB_UNICASTIPADDRESS_ROW エントリ内の変更したいメンバーを変更し、SetUnicastIpAddressEntry 関数を呼び出すことができます。

アプリケーションは、変更を行う前に InitializeUnicastIpAddressEntry 関数を呼び出して、MIB_UNICASTIPADDRESS_ROW 構造体エントリのメンバーを既定値で初期化することもできます。ただし、通常、アプリケーションは InitializeUnicastIpAddressEntry を呼び出す前に InterfaceLuid または InterfaceIndex メンバーを保存し、呼び出し後にこれらのメンバーのいずれかを復元します。

Row パラメーターが指す MIB_UNICASTIPADDRESS_ROW 構造体の Address メンバーは、有効なユニキャスト IPv4 または IPv6 アドレスおよびファミリーで初期化されている必要があります。さらに、Row パラメーターが指す MIB_UNICASTIPADDRESS_ROW 構造体内の次のメンバーのうち、少なくとも 1 つを初期化する必要があります。すなわち、InterfaceLuid または InterfaceIndex です。

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

Row パラメーターが指す MIB_UNICASTIPADDRESS_ROWOnLinkPrefixLength メンバーが 255 に設定されている場合、SetUnicastIpAddressEntry は、OnLinkPrefixLength メンバーが IP アドレスの長さと等しくなるようにユニキャスト IP アドレスのプロパティを設定します。したがって、ユニキャスト IPv4 アドレスの場合は OnLinkPrefixLength が 32 に設定され、ユニキャスト IPv6 アドレスの場合は OnLinkPrefixLength が 128 に設定されます。これにより IPv4 アドレスのサブネットマスクや IPv6 アドレスのリンクプレフィックスが正しくなくなる場合は、アプリケーションは SetUnicastIpAddressEntry を呼び出す前にこのメンバーを正しい値に設定する必要があります。

Row が指す MIB_UNICASTIPADDRESS_ROW 構造体の DadStateScopeId、および CreationTimeStamp メンバーは、SetUnicastIpAddressEntry 関数が呼び出されるときには無視されます。これらのメンバーはネットワークスタックによって設定され、SetUnicastIpAddressEntry 関数を使用して変更することはできません。ScopeId メンバーは、アドレスが追加されたインターフェイスによって自動的に決定されます。

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

SetUnicastIpAddressEntry 関数は、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 SetUnicastIpAddressEntry(
    const MIB_UNICASTIPADDRESS_ROW* Row
);
[DllImport("IPHLPAPI.dll", ExactSpelling = true)]
static extern uint SetUnicastIpAddressEntry(
    IntPtr Row   // MIB_UNICASTIPADDRESS_ROW*
);
<DllImport("IPHLPAPI.dll", ExactSpelling:=True)>
Public Shared Function SetUnicastIpAddressEntry(
    Row As IntPtr   ' MIB_UNICASTIPADDRESS_ROW*
) As UInteger
End Function
' Row : MIB_UNICASTIPADDRESS_ROW*
Declare PtrSafe Function SetUnicastIpAddressEntry 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

SetUnicastIpAddressEntry = ctypes.windll.iphlpapi.SetUnicastIpAddressEntry
SetUnicastIpAddressEntry.restype = wintypes.DWORD
SetUnicastIpAddressEntry.argtypes = [
    ctypes.c_void_p,  # Row : MIB_UNICASTIPADDRESS_ROW*
]
require 'fiddle'
require 'fiddle/import'

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

var (
	iphlpapi = windows.NewLazySystemDLL("IPHLPAPI.dll")
	procSetUnicastIpAddressEntry = iphlpapi.NewProc("SetUnicastIpAddressEntry")
)

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

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

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

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

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

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

関連項目

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