ホーム › NetworkManagement.IpHelper › InitializeUnicastIpAddressEntry

InitializeUnicastIpAddressEntry

関数

ユニキャストIPアドレス行構造体を既定値で初期化する。

DLLIPHLPAPI.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

void InitializeUnicastIpAddressEntry(
    MIB_UNICASTIPADDRESS_ROW* Row
);

パラメーター

名前	型	方向	説明
Row	MIB_UNICASTIPADDRESS_ROW*	out	入力時には、ユニキャスト IP アドレスエントリの MIB_UNICASTIPADDRESS_ROW 構造体エントリへのポインターを指定します。戻り時には、このパラメーターが指す MIB_UNICASTIPADDRESS_ROW 構造体が、ユニキャスト IP アドレス用の既定値で初期化されます。

戻り値の型: void

公式ドキュメント

ローカルコンピューター上のユニキャスト IP アドレスエントリ用に、MIB_UNICASTIPADDRESS_ROW 構造体を既定値で初期化します。

戻り値

この関数は値を返しません。

解説(Remarks)

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

InitializeUnicastIpAddressEntry 関数は、後で CreateUnicastIpAddressEntry 関数で使用するために、 MIB_UNICASTIPADDRESS_ROW 構造体エントリのメンバーをユニキャスト IP アドレス用の既定値で初期化する際に使用する必要があります。

入力時には、初期化する新しい MIB_UNICASTIPADDRESS_ROW 構造体を InitializeUnicastIpAddressEntry に渡す必要があります。

出力時には、Row パラメーターが指す MIB_UNICASTIPADDRESS_ROW 構造体の PrefixOrigin メンバーが IpPrefixOriginUnchanged に、SuffixOrigin メンバーが IpSuffixOriginUnchanged に、OnLinkPrefixLength メンバーが無効な値に初期化されます。さらに、PreferredLifetime および ValidLifetime メンバーは無限大に設定され、SkipAsSource メンバーは FALSE に設定され、その他のフィールドはゼロに初期化されます。

InitializeUnicastIpAddressEntry を呼び出した後、アプリケーションは MIB_UNICASTIPADDRESS_ROW エントリ内の変更したいメンバーを変更し、その後 CreateUnicastIpAddressEntry を呼び出して、新しいユニキャスト IP アドレスをローカルコンピューターに追加できます。

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

各言語での呼び出し定義

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

void InitializeUnicastIpAddressEntry(
    MIB_UNICASTIPADDRESS_ROW* Row
);

[DllImport("IPHLPAPI.dll", ExactSpelling = true)]
static extern void InitializeUnicastIpAddressEntry(
    IntPtr Row   // MIB_UNICASTIPADDRESS_ROW* out
);

<DllImport("IPHLPAPI.dll", ExactSpelling:=True)>
Public Shared Sub InitializeUnicastIpAddressEntry(
    Row As IntPtr   ' MIB_UNICASTIPADDRESS_ROW* out
)
End Sub

' Row : MIB_UNICASTIPADDRESS_ROW* out
Declare PtrSafe Sub InitializeUnicastIpAddressEntry Lib "iphlpapi" ( _
    ByVal Row As LongPtr)
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

InitializeUnicastIpAddressEntry = ctypes.windll.iphlpapi.InitializeUnicastIpAddressEntry
InitializeUnicastIpAddressEntry.restype = None
InitializeUnicastIpAddressEntry.argtypes = [
    ctypes.c_void_p,  # Row : MIB_UNICASTIPADDRESS_ROW* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('IPHLPAPI.dll')
InitializeUnicastIpAddressEntry = Fiddle::Function.new(
  lib['InitializeUnicastIpAddressEntry'],
  [
    Fiddle::TYPE_VOIDP,  # Row : MIB_UNICASTIPADDRESS_ROW* out
  ],
  Fiddle::TYPE_VOID)

#[link(name = "iphlpapi")]
extern "system" {
    fn InitializeUnicastIpAddressEntry(
        Row: *mut MIB_UNICASTIPADDRESS_ROW  // MIB_UNICASTIPADDRESS_ROW* out
    );
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("IPHLPAPI.dll")]
public static extern void InitializeUnicastIpAddressEntry(IntPtr Row);
"@
$api = Add-Type -MemberDefinition $sig -Name 'IPHLPAPI_InitializeUnicastIpAddressEntry' -Namespace Win32 -PassThru
# $api::InitializeUnicastIpAddressEntry(Row)

#uselib "IPHLPAPI.dll"
#func global InitializeUnicastIpAddressEntry "InitializeUnicastIpAddressEntry" sptr
; InitializeUnicastIpAddressEntry varptr(Row)
; Row : MIB_UNICASTIPADDRESS_ROW* out -> "sptr"

出力引数:

#uselib "IPHLPAPI.dll"
#func global InitializeUnicastIpAddressEntry "InitializeUnicastIpAddressEntry" var
; InitializeUnicastIpAddressEntry Row
; Row : MIB_UNICASTIPADDRESS_ROW* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "IPHLPAPI.dll"
#func global InitializeUnicastIpAddressEntry "InitializeUnicastIpAddressEntry" sptr
; InitializeUnicastIpAddressEntry varptr(Row)
; Row : MIB_UNICASTIPADDRESS_ROW* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。