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

RtmGetListEnumRoutes

関数
列挙ハンドルからルートリスト内のルート群を取得する。
DLLrtm.dll呼出規約winapi対応OSwindowsserver2000

シグネチャ

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

DWORD RtmGetListEnumRoutes(
    INT_PTR RtmRegHandle,
    INT_PTR EnumHandle,
    DWORD* NumRoutes,
    INT_PTR* RouteHandles
);

パラメーター

名前方向説明
RtmRegHandleINT_PTRinRTMクライアント登録ハンドル。
EnumHandleINT_PTRinRtmCreateRouteListEnumで得た列挙ハンドル。
NumRoutesDWORD*inout入力で配列容量、出力で取得したルート数を受け渡すDWORDポインタ。
RouteHandlesINT_PTR*out列挙されたルートハンドルを受け取る呼び出し側確保の配列。

戻り値の型: DWORD

各言語での呼び出し定義

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

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

RtmGetListEnumRoutes = ctypes.windll.rtm.RtmGetListEnumRoutes
RtmGetListEnumRoutes.restype = wintypes.DWORD
RtmGetListEnumRoutes.argtypes = [
    ctypes.c_ssize_t,  # RtmRegHandle : INT_PTR
    ctypes.c_ssize_t,  # EnumHandle : INT_PTR
    ctypes.POINTER(wintypes.DWORD),  # NumRoutes : DWORD* in/out
    ctypes.POINTER(ctypes.c_ssize_t),  # RouteHandles : INT_PTR* out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	rtm = windows.NewLazySystemDLL("rtm.dll")
	procRtmGetListEnumRoutes = rtm.NewProc("RtmGetListEnumRoutes")
)

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

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

typedef RtmGetListEnumRoutesNative = Uint32 Function(IntPtr, IntPtr, Pointer<Uint32>, Pointer<IntPtr>);
typedef RtmGetListEnumRoutesDart = int Function(int, int, Pointer<Uint32>, Pointer<IntPtr>);
final RtmGetListEnumRoutes = DynamicLibrary.open('rtm.dll')
    .lookupFunction<RtmGetListEnumRoutesNative, RtmGetListEnumRoutesDart>('RtmGetListEnumRoutes');
// RtmRegHandle : INT_PTR -> IntPtr
// EnumHandle : INT_PTR -> IntPtr
// NumRoutes : DWORD* in/out -> Pointer<Uint32>
// RouteHandles : INT_PTR* out -> Pointer<IntPtr>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function RtmGetListEnumRoutes(
  RtmRegHandle: NativeInt;   // INT_PTR
  EnumHandle: NativeInt;   // INT_PTR
  NumRoutes: Pointer;   // DWORD* in/out
  RouteHandles: Pointer   // INT_PTR* out
): DWORD; stdcall;
  external 'rtm.dll' name 'RtmGetListEnumRoutes';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "RtmGetListEnumRoutes"
  c_RtmGetListEnumRoutes :: CIntPtr -> CIntPtr -> Ptr Word32 -> Ptr CIntPtr -> IO Word32
-- RtmRegHandle : INT_PTR -> CIntPtr
-- EnumHandle : INT_PTR -> CIntPtr
-- NumRoutes : DWORD* in/out -> Ptr Word32
-- RouteHandles : INT_PTR* out -> Ptr CIntPtr
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let rtmgetlistenumroutes =
  foreign "RtmGetListEnumRoutes"
    (intptr_t @-> intptr_t @-> (ptr uint32_t) @-> (ptr intptr_t) @-> returning uint32_t)
(* RtmRegHandle : INT_PTR -> intptr_t *)
(* EnumHandle : INT_PTR -> intptr_t *)
(* NumRoutes : DWORD* in/out -> (ptr uint32_t) *)
(* RouteHandles : INT_PTR* out -> (ptr intptr_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library rtm (t "rtm.dll"))
(cffi:use-foreign-library rtm)

(cffi:defcfun ("RtmGetListEnumRoutes" rtm-get-list-enum-routes :convention :stdcall) :uint32
  (rtm-reg-handle :int64)   ; INT_PTR
  (enum-handle :int64)   ; INT_PTR
  (num-routes :pointer)   ; DWORD* in/out
  (route-handles :pointer))   ; INT_PTR* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $RtmGetListEnumRoutes = Win32::API::More->new('rtm',
    'DWORD RtmGetListEnumRoutes(LPARAM RtmRegHandle, LPARAM EnumHandle, LPVOID NumRoutes, LPVOID RouteHandles)');
# my $ret = $RtmGetListEnumRoutes->Call($RtmRegHandle, $EnumHandle, $NumRoutes, $RouteHandles);
# RtmRegHandle : INT_PTR -> LPARAM
# EnumHandle : INT_PTR -> LPARAM
# NumRoutes : DWORD* in/out -> LPVOID
# RouteHandles : INT_PTR* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。