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

RtmAddNextHop

関数
ネクストホップをルーティングテーブルに追加する。
DLLrtm.dll呼出規約winapi対応OSwindowsserver2000

シグネチャ

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

DWORD RtmAddNextHop(
    INT_PTR RtmRegHandle,
    RTM_NEXTHOP_INFO* NextHopInfo,
    INT_PTR* NextHopHandle,
    DWORD* ChangeFlags
);

パラメーター

名前方向説明
RtmRegHandleINT_PTRinRtmRegisterEntityで取得したRTM登録ハンドル。
NextHopInfoRTM_NEXTHOP_INFO*inout追加するネクストホップの情報を格納したRTM_NEXTHOP_INFO構造体へのポインタ。
NextHopHandleINT_PTR*inout追加されたネクストホップのハンドルを受け取るポインタ。
ChangeFlagsDWORD*inout操作によって生じた変更内容を示すフラグを受け取るポインタ。

戻り値の型: DWORD

各言語での呼び出し定義

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

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

RtmAddNextHop = ctypes.windll.rtm.RtmAddNextHop
RtmAddNextHop.restype = wintypes.DWORD
RtmAddNextHop.argtypes = [
    ctypes.c_ssize_t,  # RtmRegHandle : INT_PTR
    ctypes.c_void_p,  # NextHopInfo : RTM_NEXTHOP_INFO* in/out
    ctypes.POINTER(ctypes.c_ssize_t),  # NextHopHandle : INT_PTR* in/out
    ctypes.POINTER(wintypes.DWORD),  # ChangeFlags : DWORD* in/out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	rtm = windows.NewLazySystemDLL("rtm.dll")
	procRtmAddNextHop = rtm.NewProc("RtmAddNextHop")
)

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

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

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

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

(cffi:defcfun ("RtmAddNextHop" rtm-add-next-hop :convention :stdcall) :uint32
  (rtm-reg-handle :int64)   ; INT_PTR
  (next-hop-info :pointer)   ; RTM_NEXTHOP_INFO* in/out
  (next-hop-handle :pointer)   ; INT_PTR* in/out
  (change-flags :pointer))   ; DWORD* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $RtmAddNextHop = Win32::API::More->new('rtm',
    'DWORD RtmAddNextHop(LPARAM RtmRegHandle, LPVOID NextHopInfo, LPVOID NextHopHandle, LPVOID ChangeFlags)');
# my $ret = $RtmAddNextHop->Call($RtmRegHandle, $NextHopInfo, $NextHopHandle, $ChangeFlags);
# RtmRegHandle : INT_PTR -> LPARAM
# NextHopInfo : RTM_NEXTHOP_INFO* in/out -> LPVOID
# NextHopHandle : INT_PTR* in/out -> LPVOID
# ChangeFlags : DWORD* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型