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

RtmRegisterForChangeNotification

関数
ルーティング情報の変更通知を受け取るために登録する。
DLLrtm.dll呼出規約winapi対応OSwindowsserver2000

シグネチャ

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

DWORD RtmRegisterForChangeNotification(
    INT_PTR RtmRegHandle,
    DWORD TargetViews,
    DWORD NotifyFlags,
    void* NotifyContext,
    INT_PTR* NotifyHandle
);

パラメーター

名前方向説明
RtmRegHandleINT_PTRinRtmRegisterEntityで取得したRTMクライアント登録ハンドル。操作対象のアドレスファミリ/プロトコルを識別する。
TargetViewsDWORDin変更通知を受ける対象ビューのビットマスク。ユニキャスト/マルチキャスト等のRTM_VIEW_xxxを指定する。
NotifyFlagsDWORDin通知の挙動を制御するフラグ。RTM_NOTIFY_xxx(変更/停止/再開など)を組み合わせて指定する。
NotifyContextvoid*inoutコールバックへ引き渡される任意のユーザー定義コンテキストポインタ。不要ならNULL可。
NotifyHandleINT_PTR*inout取得した変更通知ハンドルを受け取る出力先。後続の変更取得や解除に使用する。

戻り値の型: DWORD

各言語での呼び出し定義

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

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

RtmRegisterForChangeNotification = ctypes.windll.rtm.RtmRegisterForChangeNotification
RtmRegisterForChangeNotification.restype = wintypes.DWORD
RtmRegisterForChangeNotification.argtypes = [
    ctypes.c_ssize_t,  # RtmRegHandle : INT_PTR
    wintypes.DWORD,  # TargetViews : DWORD
    wintypes.DWORD,  # NotifyFlags : DWORD
    ctypes.POINTER(None),  # NotifyContext : void* in/out
    ctypes.POINTER(ctypes.c_ssize_t),  # NotifyHandle : INT_PTR* in/out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	rtm = windows.NewLazySystemDLL("rtm.dll")
	procRtmRegisterForChangeNotification = rtm.NewProc("RtmRegisterForChangeNotification")
)

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

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

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

let rtmregisterforchangenotification =
  foreign "RtmRegisterForChangeNotification"
    (intptr_t @-> uint32_t @-> uint32_t @-> (ptr void) @-> (ptr intptr_t) @-> returning uint32_t)
(* RtmRegHandle : INT_PTR -> intptr_t *)
(* TargetViews : DWORD -> uint32_t *)
(* NotifyFlags : DWORD -> uint32_t *)
(* NotifyContext : void* in/out -> (ptr void) *)
(* NotifyHandle : INT_PTR* in/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 ("RtmRegisterForChangeNotification" rtm-register-for-change-notification :convention :stdcall) :uint32
  (rtm-reg-handle :int64)   ; INT_PTR
  (target-views :uint32)   ; DWORD
  (notify-flags :uint32)   ; DWORD
  (notify-context :pointer)   ; void* in/out
  (notify-handle :pointer))   ; INT_PTR* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $RtmRegisterForChangeNotification = Win32::API::More->new('rtm',
    'DWORD RtmRegisterForChangeNotification(LPARAM RtmRegHandle, DWORD TargetViews, DWORD NotifyFlags, LPVOID NotifyContext, LPVOID NotifyHandle)');
# my $ret = $RtmRegisterForChangeNotification->Call($RtmRegHandle, $TargetViews, $NotifyFlags, $NotifyContext, $NotifyHandle);
# RtmRegHandle : INT_PTR -> LPARAM
# TargetViews : DWORD -> DWORD
# NotifyFlags : DWORD -> DWORD
# NotifyContext : void* in/out -> LPVOID
# NotifyHandle : INT_PTR* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。