ホーム › NetworkManagement.IpHelper › InitializeIpForwardEntry

InitializeIpForwardEntry

関数

IP経路行構造体を既定値で初期化する。

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

シグネチャ

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

void InitializeIpForwardEntry(
    MIB_IPFORWARD_ROW2* Row
);

パラメーター

名前	型	方向	説明
Row	MIB_IPFORWARD_ROW2*	out	入力時には、IPルートエントリ用の MIB_IPFORWARD_ROW2 構造体エントリへのポインターです。戻り時には、このパラメーターが指す MIB_IPFORWARD_ROW2 構造体が、IPルートエントリ用の既定値で初期化されます。

戻り値の型: void

公式ドキュメント

ローカルコンピューター上のIPルートエントリ用に、MIB_IPFORWARD_ROW2 構造体を既定値で初期化します。

戻り値

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

解説(Remarks)

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

InitializeIpForwardEntry 関数は、後で CreateIpForwardEntry2 関数で使用するために、 MIB_IPFORWARD_ROW2 構造体エントリのメンバーを、IPルートエントリ用の既定値で初期化するために使用する必要があります。

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

出力時には、Row パラメーターが指す MIB_IPFORWARD_ROW2 構造体の ValidLifetime および PreferredLifetime メンバーは無限大に初期化され、Loopback、AutoconfigureAddress、Publish、Immortal の各メンバーは TRUE に初期化されます。さらに、SitePrefixLength、Metric、Protocol の各メンバーは不正な値に設定され、その他のフィールドはゼロに初期化されます。

InitializeIpForwardEntry を呼び出した後、アプリケーションは MIB_IPFORWARD_ROW2 エントリ内の変更したいメンバーを変更し、CreateIpForwardEntry2 を呼び出して、新しい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 InitializeIpForwardEntry(
    MIB_IPFORWARD_ROW2* Row
);

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

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

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

import ctypes
from ctypes import wintypes

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

require 'fiddle'
require 'fiddle/import'

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

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

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

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

出力引数:

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