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

GetIpForwardEntry2

関数
指定したIP経路エントリの情報を取得する。
DLLIPHLPAPI.dll呼出規約winapi対応OSWindows Vista 以降
📘 Microsoft Learn (日本語) · English

シグネチャ

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

WIN32_ERROR GetIpForwardEntry2(
    MIB_IPFORWARD_ROW2* Row
);

パラメーター

名前型方向説明
RowMIB_IPFORWARD_ROW2*inoutIP ルートエントリの MIB_IPFORWARD_ROW2 構造体エントリへのポインター。正常に復帰すると、この構造体は IP ルートエントリのプロパティで更新されます。

戻り値の型: WIN32_ERROR

公式ドキュメント

ローカルコンピューター上の IP ルートエントリの情報を取得します。

戻り値

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

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

戻りコード 説明
ERROR_INVALID_PARAMETER
 無効なパラメーターが関数に渡されました。このエラーは、Row パラメーターに NULL ポインターが渡された場合、Row パラメーターが指す MIB_IPFORWARD_ROW2 の DestinationPrefix メンバーが指定されていない場合、Row パラメーターが指す MIB_IPFORWARD_ROW2 の NextHop メンバーが指定されていない場合、または Row パラメーターが指す MIB_IPFORWARD_ROW2 の InterfaceLuid メンバーと InterfaceIndex メンバーの両方が指定されていない場合に返されます。
ERROR_NOT_FOUND
 要素が見つかりません。このエラーは、Row パラメーターが指す MIB_IPFORWARD_ROW2 構造体の InterfaceLuid メンバーまたは InterfaceIndex メンバーで指定されたネットワークインターフェイスが、MIB_IPFORWARD_ROW2 構造体の DestinationPrefix メンバーで指定された IP アドレスプレフィックスおよびアドレスファミリと一致しない場合に返されます。
ERROR_NOT_SUPPORTED
 要求はサポートされていません。このエラーは、ローカルコンピューターに IPv4 スタックが存在せず、Row パラメーターが指す MIB_IPFORWARD_ROW2 の DestinationPrefix メンバーのアドレスファミリに AF_INET が指定された場合に返されます。また、ローカルコンピューターに IPv6 スタックが存在せず、DestinationPrefix メンバーのアドレスファミリに AF_INET6 が指定された場合にも返されます。
その他

FormatMessage を使用して、返されたエラーのメッセージ文字列を取得してください。

解説(Remarks)

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

GetIpForwardEntry2 関数は、MIB_IPFORWARD_ROW2 構造体エントリを取得するために使用します。

入力時には、Row パラメーターが指す MIB_IPFORWARD_ROW2 構造体の DestinationPrefix メンバーを、有効な IPv4 または IPv6 アドレスプレフィックスおよびファミリで初期化しておく必要があります。入力時には、Row パラメーターが指す MIB_IPFORWARD_ROW2 構造体の NextHop メンバーを、有効な IPv4 または IPv6 アドレスおよびファミリで初期化しておく必要があります。さらに、Row パラメーターが指す MIB_IPFORWARD_ROW2 構造体の次のメンバーのうち、少なくとも 1 つを初期化しておく必要があります。InterfaceLuid または InterfaceIndex です。

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

呼び出しが成功した場合の出力時には、GetIpForwardEntry2 は IP ルートエントリのその他のプロパティを取得し、Row パラメーターが指す MIB_IPFORWARD_ROW2 構造体に値を設定します。

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

ローカルコンピューター上の IP ルートエントリを列挙するには、GetIpForwardTable2 関数を呼び出します。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 GetIpForwardEntry2(
    MIB_IPFORWARD_ROW2* Row
);
[DllImport("IPHLPAPI.dll", ExactSpelling = true)]
static extern uint GetIpForwardEntry2(
    IntPtr Row   // MIB_IPFORWARD_ROW2* in/out
);
<DllImport("IPHLPAPI.dll", ExactSpelling:=True)>
Public Shared Function GetIpForwardEntry2(
    Row As IntPtr   ' MIB_IPFORWARD_ROW2* in/out
) As UInteger
End Function
' Row : MIB_IPFORWARD_ROW2* in/out
Declare PtrSafe Function GetIpForwardEntry2 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

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

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

var (
	iphlpapi = windows.NewLazySystemDLL("IPHLPAPI.dll")
	procGetIpForwardEntry2 = iphlpapi.NewProc("GetIpForwardEntry2")
)

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

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

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

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

関連項目

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