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

RtmGetRouteInfo

関数
指定したルートの情報と宛先アドレスを取得する。
DLLrtm.dll呼出規約winapi対応OSwindowsserver2000

シグネチャ

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

DWORD RtmGetRouteInfo(
    INT_PTR RtmRegHandle,
    INT_PTR RouteHandle,
    RTM_ROUTE_INFO* RouteInfo,
    RTM_NET_ADDRESS* DestAddress
);

パラメーター

名前方向説明
RtmRegHandleINT_PTRinRtmRegisterEntityで取得したRTM登録ハンドル。
RouteHandleINT_PTRin情報を取得する対象ルートのハンドル。
RouteInfoRTM_ROUTE_INFO*inout取得したルート情報を受け取るRTM_ROUTE_INFO構造体へのポインタ。
DestAddressRTM_NET_ADDRESS*inoutルートの宛先ネットワークアドレスを受け取るRTM_NET_ADDRESS構造体へのポインタ。不要ならNULL可。

戻り値の型: DWORD

各言語での呼び出し定義

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

DWORD RtmGetRouteInfo(
    INT_PTR RtmRegHandle,
    INT_PTR RouteHandle,
    RTM_ROUTE_INFO* RouteInfo,
    RTM_NET_ADDRESS* DestAddress
);
[DllImport("rtm.dll", ExactSpelling = true)]
static extern uint RtmGetRouteInfo(
    IntPtr RtmRegHandle,   // INT_PTR
    IntPtr RouteHandle,   // INT_PTR
    IntPtr RouteInfo,   // RTM_ROUTE_INFO* in/out
    IntPtr DestAddress   // RTM_NET_ADDRESS* in/out
);
<DllImport("rtm.dll", ExactSpelling:=True)>
Public Shared Function RtmGetRouteInfo(
    RtmRegHandle As IntPtr,   ' INT_PTR
    RouteHandle As IntPtr,   ' INT_PTR
    RouteInfo As IntPtr,   ' RTM_ROUTE_INFO* in/out
    DestAddress As IntPtr   ' RTM_NET_ADDRESS* in/out
) As UInteger
End Function
' RtmRegHandle : INT_PTR
' RouteHandle : INT_PTR
' RouteInfo : RTM_ROUTE_INFO* in/out
' DestAddress : RTM_NET_ADDRESS* in/out
Declare PtrSafe Function RtmGetRouteInfo Lib "rtm" ( _
    ByVal RtmRegHandle As LongPtr, _
    ByVal RouteHandle As LongPtr, _
    ByVal RouteInfo As LongPtr, _
    ByVal DestAddress As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

RtmGetRouteInfo = ctypes.windll.rtm.RtmGetRouteInfo
RtmGetRouteInfo.restype = wintypes.DWORD
RtmGetRouteInfo.argtypes = [
    ctypes.c_ssize_t,  # RtmRegHandle : INT_PTR
    ctypes.c_ssize_t,  # RouteHandle : INT_PTR
    ctypes.c_void_p,  # RouteInfo : RTM_ROUTE_INFO* in/out
    ctypes.c_void_p,  # DestAddress : RTM_NET_ADDRESS* in/out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	rtm = windows.NewLazySystemDLL("rtm.dll")
	procRtmGetRouteInfo = rtm.NewProc("RtmGetRouteInfo")
)

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

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

foreign import stdcall safe "RtmGetRouteInfo"
  c_RtmGetRouteInfo :: CIntPtr -> CIntPtr -> Ptr () -> Ptr () -> IO Word32
-- RtmRegHandle : INT_PTR -> CIntPtr
-- RouteHandle : INT_PTR -> CIntPtr
-- RouteInfo : RTM_ROUTE_INFO* in/out -> Ptr ()
-- DestAddress : RTM_NET_ADDRESS* in/out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let rtmgetrouteinfo =
  foreign "RtmGetRouteInfo"
    (intptr_t @-> intptr_t @-> (ptr void) @-> (ptr void) @-> returning uint32_t)
(* RtmRegHandle : INT_PTR -> intptr_t *)
(* RouteHandle : INT_PTR -> intptr_t *)
(* RouteInfo : RTM_ROUTE_INFO* in/out -> (ptr void) *)
(* DestAddress : RTM_NET_ADDRESS* in/out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library rtm (t "rtm.dll"))
(cffi:use-foreign-library rtm)

(cffi:defcfun ("RtmGetRouteInfo" rtm-get-route-info :convention :stdcall) :uint32
  (rtm-reg-handle :int64)   ; INT_PTR
  (route-handle :int64)   ; INT_PTR
  (route-info :pointer)   ; RTM_ROUTE_INFO* in/out
  (dest-address :pointer))   ; RTM_NET_ADDRESS* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $RtmGetRouteInfo = Win32::API::More->new('rtm',
    'DWORD RtmGetRouteInfo(LPARAM RtmRegHandle, LPARAM RouteHandle, LPVOID RouteInfo, LPVOID DestAddress)');
# my $ret = $RtmGetRouteInfo->Call($RtmRegHandle, $RouteHandle, $RouteInfo, $DestAddress);
# RtmRegHandle : INT_PTR -> LPARAM
# RouteHandle : INT_PTR -> LPARAM
# RouteInfo : RTM_ROUTE_INFO* in/out -> LPVOID
# DestAddress : RTM_NET_ADDRESS* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型