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

GetIpForwardTable

関数
IPv4のルーティングテーブル(経路情報)を取得する。
DLLIPHLPAPI.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

DWORD GetIpForwardTable(
    MIB_IPFORWARDTABLE* pIpForwardTable,   // optional
    DWORD* pdwSize,
    BOOL bOrder
);

パラメーター

名前方向説明
pIpForwardTableMIB_IPFORWARDTABLE*outoptionalIPv4 ルーティングテーブルを MIB_IPFORWARDTABLE 構造体として受け取るバッファーへのポインター。
pdwSizeDWORD*inout

入力時には、pIpForwardTable パラメーターが指すバッファーのサイズをバイト単位で指定します。

出力時には、バッファーが返されるルーティングテーブルを格納するのに十分な大きさでない場合、関数はこのパラメーターに必要なバッファーサイズをバイト単位で設定します。

bOrderBOOLin

返されるテーブルをソートするかどうかを指定する Boolean 値。このパラメーターが TRUE の場合、テーブルは次の順序でソートされます。

  1. 宛先アドレス
  2. ルートを生成したプロトコル
  3. マルチパスルーティングポリシー
  4. ネクストホップアドレス

戻り値の型: DWORD

公式ドキュメント

GetIpForwardTable 関数は IPv4 ルーティングテーブルを取得します。

戻り値

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

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

戻り値 説明
ERROR_INSUFFICIENT_BUFFER
pIpForwardTable パラメーターが指すバッファーが十分な大きさではありません。必要なサイズは、pdwSize パラメーターが指す DWORD 変数に返されます。
ERROR_INVALID_PARAMETER
pdwSize パラメーターが NULL であるか、または GetIpForwardTablepdwSize パラメーターの指すメモリーに書き込めません。
ERROR_NO_DATA
利用可能なデータがありません。このエラーは、ローカルコンピューターにルートが存在しない場合に返されます。
ERROR_NOT_SUPPORTED
この関数は、ローカルシステムで使用されているオペレーティングシステムではサポートされていません。このエラーは、ローカルコンピューターに IP スタックがインストールされていない場合に返されます。
その他
返されたエラーのメッセージ文字列を取得するには FormatMessage を使用してください。

解説(Remarks)

MIB_IPFORWARDROW 構造体の dwForwardProto メンバーは、ルートを生成したプロトコルまたはルーティングメカニズムを指定します。指定可能なプロトコルおよびルーティングメカニズムの一覧については、 Protocol Identifiers を参照してください。

MIB_IPFORWARDROW 構造体の dwForwardDestdwForwardMaskdwForwardNextHop の各メンバーは、ネットワークバイトオーダーの IPv4 アドレスを表します。

MIB_IPFORWARDROW 構造体の dwForwardDest メンバーが 0.0.0.0 という IPv4 アドレスの場合、それはデフォルトルートとみなされます。複数のネットワークアダプターがインストールされている場合、MIB_IPFORWARDTABLE には、dwForwardDest メンバーが 0.0.0.0 に設定された MIB_IPFORWARDROW エントリが複数含まれることがあります。

dwForwardAgeINFINITE に設定されている場合、ルートはタイムアウト値に基づいて削除されません。dwForwardAge のその他の値は、そのルートがネットワークルーティングテーブルに追加または変更されてからの経過秒数を指定します。

Windows Server 2003 または Windows 2000 Server でルーティングとリモートアクセスサービス(RRAS)が実行されている場合、返される MIB_IPFORWARDROW エントリでは、dwForwardType および dwForwardAge メンバーがゼロに設定されます。

Windows Vista および Windows Server 2008 では、MIB_IPFORWARDROW 構造体の dwForwardMetric1 メンバーで指定されるルートメトリックは、ルートメトリックに、関連付けられたインターフェイスの MIB_IPINTERFACE_ROW 構造体の Metric メンバーで指定されるインターフェイスメトリックを加算したものを表します。したがって、MIB_IPFORWARDROW 構造体の dwForwardMetric1 メンバーは、関連付けられた MIB_IPINTERFACE_ROW 構造体の Metric メンバー以上の値になります。Windows Vista および Windows Server 2008 でアプリケーションがルートメトリックを 0 に設定したい場合は、MIB_IPFORWARDROW 構造体の dwForwardMetric1 メンバーを、関連付けられた MIB_IPINTERFACE_ROW 構造体の Metric メンバーで指定されたインターフェイスメトリックの値と等しく設定する必要があります。アプリケーションは、GetIpInterfaceEntry 関数を呼び出すことでインターフェイスメトリックを取得できます。

GetIpForwardTable が返す MIB_IPFORWARDROW 構造体エントリのいくつかのメンバーは、現在 IPv4 ルーティングでは使用されていません。これらのメンバーには、dwForwardPolicydwForwardNextHopASdwForwardMetric2dwForwardMetric3dwForwardMetric4dwForwardMetric5 が含まれます。

次の例は、IP ルーティングテーブルを取得し、テーブル内の各ルートについていくつかのフィールドを出力します。

// Need to link with Ws2_32.lib and Iphlpapi.lib
#include <winsock2.h>
#include <ws2tcpip.h>
#include <iphlpapi.h>
#include <stdio.h>

#pragma comment(lib, "iphlpapi.lib")
#pragma comment(lib, "ws2_32.lib")

#define MALLOC(x) HeapAlloc(GetProcessHeap(), 0, (x))
#define FREE(x) HeapFree(GetProcessHeap(), 0, (x))

/* Note: could also use malloc() and free() */

int main()
{

    // Declare and initialize variables.

    /* variables used for GetIfForwardTable */
    PMIB_IPFORWARDTABLE pIpForwardTable;
    DWORD dwSize = 0;
    DWORD dwRetVal = 0;

    char szDestIp[128];
    char szMaskIp[128];
    char szGatewayIp[128];

    struct in_addr IpAddr;

    int i;

    pIpForwardTable =
        (MIB_IPFORWARDTABLE *) MALLOC(sizeof (MIB_IPFORWARDTABLE));
    if (pIpForwardTable == NULL) {
        printf("Error allocating memory\n");
        return 1;
    }

    if (GetIpForwardTable(pIpForwardTable, &dwSize, 0) ==
        ERROR_INSUFFICIENT_BUFFER) {
        FREE(pIpForwardTable);
        pIpForwardTable = (MIB_IPFORWARDTABLE *) MALLOC(dwSize);
        if (pIpForwardTable == NULL) {
            printf("Error allocating memory\n");
            return 1;
        }
    }

    /* Note that the IPv4 addresses returned in 
     * GetIpForwardTable entries are in network byte order 
     */
    if ((dwRetVal = GetIpForwardTable(pIpForwardTable, &dwSize, 0)) == NO_ERROR) {
        printf("\tNumber of entries: %d\n",
               (int) pIpForwardTable->dwNumEntries);
        for (i = 0; i < (int) pIpForwardTable->dwNumEntries; i++) {
            /* Convert IPv4 addresses to strings */
            IpAddr.S_un.S_addr =
                (u_long) pIpForwardTable->table[i].dwForwardDest;
            strcpy_s(szDestIp, sizeof (szDestIp), inet_ntoa(IpAddr));
            IpAddr.S_un.S_addr =
                (u_long) pIpForwardTable->table[i].dwForwardMask;
            strcpy_s(szMaskIp, sizeof (szMaskIp), inet_ntoa(IpAddr));
            IpAddr.S_un.S_addr =
                (u_long) pIpForwardTable->table[i].dwForwardNextHop;
            strcpy_s(szGatewayIp, sizeof (szGatewayIp), inet_ntoa(IpAddr));

            printf("\n\tRoute[%d] Dest IP: %s\n", i, szDestIp);
            printf("\tRoute[%d] Subnet Mask: %s\n", i, szMaskIp);
            printf("\tRoute[%d] Next Hop: %s\n", i, szGatewayIp);
            printf("\tRoute[%d] If Index: %ld\n", i,
                   pIpForwardTable->table[i].dwForwardIfIndex);
            printf("\tRoute[%d] Type: %ld - ", i,
                   pIpForwardTable->table[i].dwForwardType);
            switch (pIpForwardTable->table[i].dwForwardType) {
            case MIB_IPROUTE_TYPE_OTHER:
                printf("other\n");
                break;
            case MIB_IPROUTE_TYPE_INVALID:
                printf("invalid route\n");
                break;
            case MIB_IPROUTE_TYPE_DIRECT:
                printf("local route where next hop is final destination\n");
                break;
            case MIB_IPROUTE_TYPE_INDIRECT:
                printf
                    ("remote route where next hop is not final destination\n");
                break;
            default:
                printf("UNKNOWN Type value\n");
                break;
            }
            printf("\tRoute[%d] Proto: %ld - ", i,
                   pIpForwardTable->table[i].dwForwardProto);
            switch (pIpForwardTable->table[i].dwForwardProto) {
            case MIB_IPPROTO_OTHER:
                printf("other\n");
                break;
            case MIB_IPPROTO_LOCAL:
                printf("local interface\n");
                break;
            case MIB_IPPROTO_NETMGMT:
                printf("static route set through network management \n");
                break;
            case MIB_IPPROTO_ICMP:
                printf("result of ICMP redirect\n");
                break;
            case MIB_IPPROTO_EGP:
                printf("Exterior Gateway Protocol (EGP)\n");
                break;
            case MIB_IPPROTO_GGP:
                printf("Gateway-to-Gateway Protocol (GGP)\n");
                break;
            case MIB_IPPROTO_HELLO:
                printf("Hello protocol\n");
                break;
            case MIB_IPPROTO_RIP:
                printf("Routing Information Protocol (RIP)\n");
                break;
            case MIB_IPPROTO_IS_IS:
                printf
                    ("Intermediate System-to-Intermediate System (IS-IS) protocol\n");
                break;
            case MIB_IPPROTO_ES_IS:
                printf("End System-to-Intermediate System (ES-IS) protocol\n");
                break;
            case MIB_IPPROTO_CISCO:
                printf("Cisco Interior Gateway Routing Protocol (IGRP)\n");
                break;
            case MIB_IPPROTO_BBN:
                printf("BBN Internet Gateway Protocol (IGP) using SPF\n");
                break;
            case MIB_IPPROTO_OSPF:
                printf("Open Shortest Path First (OSPF) protocol\n");
                break;
            case MIB_IPPROTO_BGP:
                printf("Border Gateway Protocol (BGP)\n");
                break;
            case MIB_IPPROTO_NT_AUTOSTATIC:
                printf("special Windows auto static route\n");
                break;
            case MIB_IPPROTO_NT_STATIC:
                printf("special Windows static route\n");
                break;
            case MIB_IPPROTO_NT_STATIC_NON_DOD:
                printf
                    ("special Windows static route not based on Internet standards\n");
                break;
            default:
                printf("UNKNOWN Proto value\n");
                break;
            }

            printf("\tRoute[%d] Age: %ld\n", i,
                   pIpForwardTable->table[i].dwForwardAge);
            printf("\tRoute[%d] Metric1: %ld\n", i,
                   pIpForwardTable->table[i].dwForwardMetric1);
        }
        FREE(pIpForwardTable);
        return 0;
    } else {
        printf("\tGetIpForwardTable failed.\n");
        FREE(pIpForwardTable);
        return 1;
    }

}

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

各言語での呼び出し定義

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

DWORD GetIpForwardTable(
    MIB_IPFORWARDTABLE* pIpForwardTable,   // optional
    DWORD* pdwSize,
    BOOL bOrder
);
[DllImport("IPHLPAPI.dll", ExactSpelling = true)]
static extern uint GetIpForwardTable(
    IntPtr pIpForwardTable,   // MIB_IPFORWARDTABLE* optional, out
    ref uint pdwSize,   // DWORD* in/out
    bool bOrder   // BOOL
);
<DllImport("IPHLPAPI.dll", ExactSpelling:=True)>
Public Shared Function GetIpForwardTable(
    pIpForwardTable As IntPtr,   ' MIB_IPFORWARDTABLE* optional, out
    ByRef pdwSize As UInteger,   ' DWORD* in/out
    bOrder As Boolean   ' BOOL
) As UInteger
End Function
' pIpForwardTable : MIB_IPFORWARDTABLE* optional, out
' pdwSize : DWORD* in/out
' bOrder : BOOL
Declare PtrSafe Function GetIpForwardTable Lib "iphlpapi" ( _
    ByVal pIpForwardTable As LongPtr, _
    ByRef pdwSize As Long, _
    ByVal bOrder As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

GetIpForwardTable = ctypes.windll.iphlpapi.GetIpForwardTable
GetIpForwardTable.restype = wintypes.DWORD
GetIpForwardTable.argtypes = [
    ctypes.c_void_p,  # pIpForwardTable : MIB_IPFORWARDTABLE* optional, out
    ctypes.POINTER(wintypes.DWORD),  # pdwSize : DWORD* in/out
    wintypes.BOOL,  # bOrder : BOOL
]
require 'fiddle'
require 'fiddle/import'

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

var (
	iphlpapi = windows.NewLazySystemDLL("IPHLPAPI.dll")
	procGetIpForwardTable = iphlpapi.NewProc("GetIpForwardTable")
)

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

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

typedef GetIpForwardTableNative = Uint32 Function(Pointer<Void>, Pointer<Uint32>, Int32);
typedef GetIpForwardTableDart = int Function(Pointer<Void>, Pointer<Uint32>, int);
final GetIpForwardTable = DynamicLibrary.open('IPHLPAPI.dll')
    .lookupFunction<GetIpForwardTableNative, GetIpForwardTableDart>('GetIpForwardTable');
// pIpForwardTable : MIB_IPFORWARDTABLE* optional, out -> Pointer<Void>
// pdwSize : DWORD* in/out -> Pointer<Uint32>
// bOrder : BOOL -> Int32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function GetIpForwardTable(
  pIpForwardTable: Pointer;   // MIB_IPFORWARDTABLE* optional, out
  pdwSize: Pointer;   // DWORD* in/out
  bOrder: BOOL   // BOOL
): DWORD; stdcall;
  external 'IPHLPAPI.dll' name 'GetIpForwardTable';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "GetIpForwardTable"
  c_GetIpForwardTable :: Ptr () -> Ptr Word32 -> CInt -> IO Word32
-- pIpForwardTable : MIB_IPFORWARDTABLE* optional, out -> Ptr ()
-- pdwSize : DWORD* in/out -> Ptr Word32
-- bOrder : BOOL -> CInt
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let getipforwardtable =
  foreign "GetIpForwardTable"
    ((ptr void) @-> (ptr uint32_t) @-> int32_t @-> returning uint32_t)
(* pIpForwardTable : MIB_IPFORWARDTABLE* optional, out -> (ptr void) *)
(* pdwSize : DWORD* in/out -> (ptr uint32_t) *)
(* bOrder : BOOL -> int32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library iphlpapi (t "IPHLPAPI.dll"))
(cffi:use-foreign-library iphlpapi)

(cffi:defcfun ("GetIpForwardTable" get-ip-forward-table :convention :stdcall) :uint32
  (p-ip-forward-table :pointer)   ; MIB_IPFORWARDTABLE* optional, out
  (pdw-size :pointer)   ; DWORD* in/out
  (b-order :int32))   ; BOOL
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $GetIpForwardTable = Win32::API::More->new('IPHLPAPI',
    'DWORD GetIpForwardTable(LPVOID pIpForwardTable, LPVOID pdwSize, BOOL bOrder)');
# my $ret = $GetIpForwardTable->Call($pIpForwardTable, $pdwSize, $bOrder);
# pIpForwardTable : MIB_IPFORWARDTABLE* optional, out -> LPVOID
# pdwSize : DWORD* in/out -> LPVOID
# bOrder : BOOL -> BOOL
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

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