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

RTM_ROUTE_INFO

構造体
サイズx64: 64 バイト / x86: 40 バイト

サイズ=各フィールドのバイト数(x64/x86 で異なる場合は x64/x86 と併記)。x64/x86 列=フィールドのバイトオフセット(HSPで dupptr / lpoke / wpoke 等に使用)。

フィールド

フィールドサイズx64x86説明
DestHandleINT_PTR8/4+0+0このルートの宛先を識別するハンドル。
RouteOwnerINT_PTR8/4+8+4ルートを所有するエンティティ(ルーティングプロトコル)のハンドル。
NeighbourINT_PTR8/4+16+8ルートを通知した隣接ルーターを識別するハンドル。
StateBYTE1+24+12ルートの状態を表すバイト値。
Flags1BYTE1+25+13ルートの追加属性を示すバイトフラグ。
FlagsWORD2+26+14ルートの属性を示すWORDフラグ(RTM_ROUTE_FLAGS_*)。
PrefInfoRTM_PREF_INFO8+28+16ルートのメトリックと優先度情報(RTM_PREF_INFO)。
BelongsToViewsDWORD4+36+24このルートが属するビューを示すビットマスク。
EntitySpecificInfovoid*8/4+40+28ルーティングプロトコル固有の情報へのポインタ。NULL可。
NextHopsListRTM_NEXTHOP_LIST16/8+48+32このルートのネクストホップ一覧(RTM_NEXTHOP_LIST)。

各言語での定義

#include <windows.h>

// RTM_PREF_INFO  (x64 8 / x86 8 バイト)
typedef struct RTM_PREF_INFO {
    DWORD Metric;
    DWORD Preference;
} RTM_PREF_INFO;

// RTM_NEXTHOP_LIST  (x64 16 / x86 8 バイト)
typedef struct RTM_NEXTHOP_LIST {
    WORD NumNextHops;
    INT_PTR NextHops[1];
} RTM_NEXTHOP_LIST;

// RTM_ROUTE_INFO  (x64 64 / x86 40 バイト)
typedef struct RTM_ROUTE_INFO {
    INT_PTR DestHandle;
    INT_PTR RouteOwner;
    INT_PTR Neighbour;
    BYTE State;
    BYTE Flags1;
    WORD Flags;
    RTM_PREF_INFO PrefInfo;
    DWORD BelongsToViews;
    void* EntitySpecificInfo;
    RTM_NEXTHOP_LIST NextHopsList;
} RTM_ROUTE_INFO;
using System;
using System.Runtime.InteropServices;

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct RTM_PREF_INFO
{
    public uint Metric;
    public uint Preference;
}

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct RTM_NEXTHOP_LIST
{
    public ushort NumNextHops;
    [MarshalAs(UnmanagedType.ByValArray, SizeConst = 1)] public IntPtr[] NextHops;
}

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct RTM_ROUTE_INFO
{
    public IntPtr DestHandle;
    public IntPtr RouteOwner;
    public IntPtr Neighbour;
    public byte State;
    public byte Flags1;
    public ushort Flags;
    public RTM_PREF_INFO PrefInfo;
    public uint BelongsToViews;
    public IntPtr EntitySpecificInfo;
    public RTM_NEXTHOP_LIST NextHopsList;
}
Imports System.Runtime.InteropServices

<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure RTM_PREF_INFO
    Public Metric As UInteger
    Public Preference As UInteger
End Structure

<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure RTM_NEXTHOP_LIST
    Public NumNextHops As UShort
    <MarshalAs(UnmanagedType.ByValArray, SizeConst:=1)> Public NextHops() As IntPtr
End Structure

<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure RTM_ROUTE_INFO
    Public DestHandle As IntPtr
    Public RouteOwner As IntPtr
    Public Neighbour As IntPtr
    Public State As Byte
    Public Flags1 As Byte
    Public Flags As UShort
    Public PrefInfo As RTM_PREF_INFO
    Public BelongsToViews As UInteger
    Public EntitySpecificInfo As IntPtr
    Public NextHopsList As RTM_NEXTHOP_LIST
End Structure
import ctypes
from ctypes import wintypes

class RTM_PREF_INFO(ctypes.Structure):
    _fields_ = [
        ("Metric", wintypes.DWORD),
        ("Preference", wintypes.DWORD),
    ]

class RTM_NEXTHOP_LIST(ctypes.Structure):
    _fields_ = [
        ("NumNextHops", ctypes.c_ushort),
        ("NextHops", ctypes.c_ssize_t * 1),
    ]

class RTM_ROUTE_INFO(ctypes.Structure):
    _fields_ = [
        ("DestHandle", ctypes.c_ssize_t),
        ("RouteOwner", ctypes.c_ssize_t),
        ("Neighbour", ctypes.c_ssize_t),
        ("State", ctypes.c_ubyte),
        ("Flags1", ctypes.c_ubyte),
        ("Flags", ctypes.c_ushort),
        ("PrefInfo", RTM_PREF_INFO),
        ("BelongsToViews", wintypes.DWORD),
        ("EntitySpecificInfo", ctypes.c_void_p),
        ("NextHopsList", RTM_NEXTHOP_LIST),
    ]
#[repr(C)]
pub struct RTM_PREF_INFO {
    pub Metric: u32,
    pub Preference: u32,
}

#[repr(C)]
pub struct RTM_NEXTHOP_LIST {
    pub NumNextHops: u16,
    pub NextHops: [isize; 1],
}

#[repr(C)]
pub struct RTM_ROUTE_INFO {
    pub DestHandle: isize,
    pub RouteOwner: isize,
    pub Neighbour: isize,
    pub State: u8,
    pub Flags1: u8,
    pub Flags: u16,
    pub PrefInfo: RTM_PREF_INFO,
    pub BelongsToViews: u32,
    pub EntitySpecificInfo: *mut core::ffi::c_void,
    pub NextHopsList: RTM_NEXTHOP_LIST,
}
import "golang.org/x/sys/windows"

type RTM_PREF_INFO struct {
	Metric uint32
	Preference uint32
}

type RTM_NEXTHOP_LIST struct {
	NumNextHops uint16
	NextHops [1]uintptr
}

type RTM_ROUTE_INFO struct {
	DestHandle uintptr
	RouteOwner uintptr
	Neighbour uintptr
	State byte
	Flags1 byte
	Flags uint16
	PrefInfo RTM_PREF_INFO
	BelongsToViews uint32
	EntitySpecificInfo uintptr
	NextHopsList RTM_NEXTHOP_LIST
}
type
  RTM_PREF_INFO = record
    Metric: DWORD;
    Preference: DWORD;
  end;

  RTM_NEXTHOP_LIST = record
    NumNextHops: Word;
    NextHops: array[0..0] of NativeInt;
  end;

  RTM_ROUTE_INFO = record
    DestHandle: NativeInt;
    RouteOwner: NativeInt;
    Neighbour: NativeInt;
    State: Byte;
    Flags1: Byte;
    Flags: Word;
    PrefInfo: RTM_PREF_INFO;
    BelongsToViews: DWORD;
    EntitySpecificInfo: Pointer;
    NextHopsList: RTM_NEXTHOP_LIST;
  end;
const RTM_PREF_INFO = extern struct {
    Metric: u32,
    Preference: u32,
};

const RTM_NEXTHOP_LIST = extern struct {
    NumNextHops: u16,
    NextHops: [1]isize,
};

const RTM_ROUTE_INFO = extern struct {
    DestHandle: isize,
    RouteOwner: isize,
    Neighbour: isize,
    State: u8,
    Flags1: u8,
    Flags: u16,
    PrefInfo: RTM_PREF_INFO,
    BelongsToViews: u32,
    EntitySpecificInfo: ?*anyopaque,
    NextHopsList: RTM_NEXTHOP_LIST,
};
type
  RTM_PREF_INFO {.bycopy.} = object
    Metric: uint32
    Preference: uint32

  RTM_NEXTHOP_LIST {.bycopy.} = object
    NumNextHops: uint16
    NextHops: array[1, int]

  RTM_ROUTE_INFO {.bycopy.} = object
    DestHandle: int
    RouteOwner: int
    Neighbour: int
    State: uint8
    Flags1: uint8
    Flags: uint16
    PrefInfo: RTM_PREF_INFO
    BelongsToViews: uint32
    EntitySpecificInfo: pointer
    NextHopsList: RTM_NEXTHOP_LIST
struct RTM_PREF_INFO
{
    uint Metric;
    uint Preference;
}

struct RTM_NEXTHOP_LIST
{
    ushort NumNextHops;
    ptrdiff_t[1] NextHops;
}

struct RTM_ROUTE_INFO
{
    ptrdiff_t DestHandle;
    ptrdiff_t RouteOwner;
    ptrdiff_t Neighbour;
    ubyte State;
    ubyte Flags1;
    ushort Flags;
    RTM_PREF_INFO PrefInfo;
    uint BelongsToViews;
    void* EntitySpecificInfo;
    RTM_NEXTHOP_LIST NextHopsList;
}

HSP用 定義

HSP3.7/3.8 は構造体機能が無いため4byte整数配列(dim)+peek/poke で操作(32/64bitでサイズ・位置が異なる場合はタブで分割)。IronHSP は NSTRUCT(#defstruct/stdim/->)で32/64bit共通。

; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x86 レイアウト)
; RTM_ROUTE_INFO サイズ: 40 バイト(x86)
dim st, 10    ; 4byte整数×10(構造体サイズ 40 / 4 切り上げ)
; DestHandle : INT_PTR (+0, 4byte)  st.0 = 値  /  値 = st.0   (lpoke/lpeek も可)
; RouteOwner : INT_PTR (+4, 4byte)  st.1 = 値  /  値 = st.1   (lpoke/lpeek も可)
; Neighbour : INT_PTR (+8, 4byte)  st.2 = 値  /  値 = st.2   (lpoke/lpeek も可)
; State : BYTE (+12, 1byte)  poke st,12,値  /  値 = peek(st,12)
; Flags1 : BYTE (+13, 1byte)  poke st,13,値  /  値 = peek(st,13)
; Flags : WORD (+14, 2byte)  wpoke st,14,値  /  値 = wpeek(st,14)
; PrefInfo : RTM_PREF_INFO (+16, 8byte)  varptr(st)+16 を基点に操作(8byte:入れ子/配列)
; BelongsToViews : DWORD (+24, 4byte)  st.6 = 値  /  値 = st.6   (lpoke/lpeek も可)
; EntitySpecificInfo : void* (+28, 4byte)  st.7 = 値  /  値 = st.7   (lpoke/lpeek も可)
; NextHopsList : RTM_NEXTHOP_LIST (+32, 8byte)  varptr(st)+32 を基点に操作(8byte:入れ子/配列)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x64 レイアウト)
; RTM_ROUTE_INFO サイズ: 64 バイト(x64)
dim st, 16    ; 4byte整数×16(構造体サイズ 64 / 4 切り上げ)
; DestHandle : INT_PTR (+0, 8byte)  qpoke st,0,値 / qpeek(st,0)  ※IronHSPのみ。3.7/3.8は lpoke st,0,下位 : lpoke st,4,上位
; RouteOwner : INT_PTR (+8, 8byte)  qpoke st,8,値 / qpeek(st,8)  ※IronHSPのみ。3.7/3.8は lpoke st,8,下位 : lpoke st,12,上位
; Neighbour : INT_PTR (+16, 8byte)  qpoke st,16,値 / qpeek(st,16)  ※IronHSPのみ。3.7/3.8は lpoke st,16,下位 : lpoke st,20,上位
; State : BYTE (+24, 1byte)  poke st,24,値  /  値 = peek(st,24)
; Flags1 : BYTE (+25, 1byte)  poke st,25,値  /  値 = peek(st,25)
; Flags : WORD (+26, 2byte)  wpoke st,26,値  /  値 = wpeek(st,26)
; PrefInfo : RTM_PREF_INFO (+28, 8byte)  varptr(st)+28 を基点に操作(8byte:入れ子/配列)
; BelongsToViews : DWORD (+36, 4byte)  st.9 = 値  /  値 = st.9   (lpoke/lpeek も可)
; EntitySpecificInfo : void* (+40, 8byte)  qpoke st,40,値 / qpeek(st,40)  ※IronHSPのみ。3.7/3.8は lpoke st,40,下位 : lpoke st,44,上位
; NextHopsList : RTM_NEXTHOP_LIST (+48, 16byte)  varptr(st)+48 を基点に操作(16byte:入れ子/配列)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; IronHSP は NSTRUCT(構造体)をサポート。32bit/64bit どちらでも同じコードで動作します。
; ※GUID・入れ子構造体はデフォルト型でないため、依存する #defstruct を先に定義(下記に同梱)。
#defstruct global RTM_PREF_INFO
    #field int Metric
    #field int Preference
#endstruct

#defstruct global RTM_NEXTHOP_LIST
    #field short NumNextHops
    #field intptr NextHops 1
#endstruct

#defstruct global RTM_ROUTE_INFO
    #field intptr DestHandle
    #field intptr RouteOwner
    #field intptr Neighbour
    #field byte State
    #field byte Flags1
    #field short Flags
    #field RTM_PREF_INFO PrefInfo
    #field int BelongsToViews
    #field intptr EntitySpecificInfo
    #field RTM_NEXTHOP_LIST NextHopsList
#endstruct

stdim st, RTM_ROUTE_INFO        ; NSTRUCT 変数を確保
st->DestHandle = 100
mes "DestHandle=" + st->DestHandle