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

NotifyRouteChange

関数
ルーティングテーブルの変更を通知するよう登録する。
DLLIPHLPAPI.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

DWORD NotifyRouteChange(
    HANDLE* Handle,
    OVERLAPPED* overlapped
);

パラメーター

名前方向説明
HandleHANDLE*out非同期通知で使用するハンドルを受け取る HANDLE 変数へのポインター。
overlappedOVERLAPPED*inルーティング テーブルの変更を呼び出し元に通知する OVERLAPPED 構造体へのポインター。

戻り値の型: DWORD

公式ドキュメント

NotifyRouteChange 関数は、IPv4 ルーティング テーブルに変更が発生するたびに、呼び出し元へ通知を送信させます。

戻り値

関数が成功し、呼び出し元が Handle および overlapped パラメーターに NULL を指定した場合、戻り値は NO_ERROR です。呼び出し元が NULL 以外のパラメーターを指定した場合、成功時の戻り値は ERROR_IO_PENDING です。関数が失敗した場合は、 FormatMessage を使用して、返されたエラーに対応するメッセージ文字列を取得してください。

Return code Description
ERROR_CANCELLED
コンテキストの登録解除が行われているため、呼び出しは直ちにキャンセルされました。
ERROR_INVALID_PARAMETER
無効なパラメーターが渡されました。このエラーは、Handle パラメーターと overlapped パラメーターの両方が NULL ではないものの、入力パラメーターで指定されたメモリに呼び出し元プロセスが書き込めない場合に返されます。また、クライアントが既に変更通知要求を行っている場合にも返され、この重複した要求は失敗します。
ERROR_NOT_ENOUGH_MEMORY
操作を完了するために利用できるメモリが不足していました。
ERROR_NOT_SUPPORTED
このエラーは、Windows 98/95 や Windows NT 4.0 など、この関数がサポートされていないバージョンの Windows で返されます。

解説(Remarks)

NotifyRouteChange 関数は、次の 2 つの方法で呼び出すことができます。

呼び出し元が Handle および overlapped パラメーターに NULL を指定した場合、 NotifyRouteChange の呼び出しは同期的となり、IPv4 ルーティング テーブルの変更が発生するまでブロックします。この場合、変更が発生すると NotifyRouteChange 関数が完了し、変更が発生したことを示します。

NotifyRouteChange 関数を同期的に呼び出した場合、アプリケーションが終了するまで、次の IPv4 ルーティング変更時に通知が送信されます。

呼び出し元がハンドル変数と OVERLAPPED 構造体を指定した場合、呼び出し元は返されたハンドルを OVERLAPPED 構造体とともに使用して、IPv4 ルーティング テーブルの変更に関する非同期通知を受け取ることができます。ハンドルと OVERLAPPED 構造体を使用して通知を受け取る方法については、次のトピックを参照してください。

アプリケーションが通知を受け取り、次の変更の通知を必要とする場合は、NotifyRouteChange 関数を再度呼び出す必要があります。

CancelIPChangeNotify 関数は、NotifyAddrChange 関数または NotifyRouteChange 関数の呼び出しが成功した際に要求した、IP アドレスおよびルートの変更通知をキャンセルします。

アプリケーションが変更を通知されると、GetIpForwardTable 関数または GetIpForwardTable2 関数を呼び出して IPv4 ルーティング テーブルを取得し、何が変更されたかを判別できます。アプリケーションが通知を受け取り、次の変更の通知を必要とする場合は、NotifyRouteChange 関数を再度呼び出す必要があります。

NotifyRouteChange 関数を非同期的に呼び出した場合、アプリケーションが CancelIPChangeNotify 関数を呼び出して通知をキャンセルするか、アプリケーションが終了するまで、次の IPv4 ルート変更時に通知が送信されます。アプリケーションが終了した場合、システムは通知の登録を自動的にキャンセルします。それでも、アプリケーションは終了前に通知を明示的にキャンセルすることが推奨されます。

通知の登録は、システムのシャットダウンや再起動をまたいで維持されることはありません。

Windows Vista 以降では、 NotifyRouteChange2 関数を使用して、ローカル コンピューター上の IPv6 ルーティング テーブルの変更通知を登録できます。

Examples

次の例は、IP ルーティング テーブルに変更が発生するのを待機します。

#include <winsock2.h>
#include <iphlpapi.h>
#include <stdio.h>
#include <windows.h>

#pragma comment(lib, "iphlpapi.lib")
#pragma comment(lib, "ws2_32.lib")

void main()
{
  OVERLAPPED overlap;
  DWORD ret;
    
  HANDLE hand = NULL;
  overlap.hEvent = WSACreateEvent();

  ret = NotifyRouteChange(&hand, &overlap);

  if (ret != NO_ERROR)
  {
    if (WSAGetLastError() != WSA_IO_PENDING)
    {
      printf("NotifyRouteChange error...%d\n", WSAGetLastError());            
      return;
    }
  }

  if ( WaitForSingleObject(overlap.hEvent, INFINITE) == WAIT_OBJECT_0 )
    printf("Routing table changed..\n");
}
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

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

DWORD NotifyRouteChange(
    HANDLE* Handle,
    OVERLAPPED* overlapped
);
[DllImport("IPHLPAPI.dll", ExactSpelling = true)]
static extern uint NotifyRouteChange(
    IntPtr Handle,   // HANDLE* out
    IntPtr overlapped   // OVERLAPPED*
);
<DllImport("IPHLPAPI.dll", ExactSpelling:=True)>
Public Shared Function NotifyRouteChange(
    Handle As IntPtr,   ' HANDLE* out
    overlapped As IntPtr   ' OVERLAPPED*
) As UInteger
End Function
' Handle : HANDLE* out
' overlapped : OVERLAPPED*
Declare PtrSafe Function NotifyRouteChange Lib "iphlpapi" ( _
    ByVal Handle As LongPtr, _
    ByVal overlapped As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

NotifyRouteChange = ctypes.windll.iphlpapi.NotifyRouteChange
NotifyRouteChange.restype = wintypes.DWORD
NotifyRouteChange.argtypes = [
    ctypes.c_void_p,  # Handle : HANDLE* out
    ctypes.c_void_p,  # overlapped : OVERLAPPED*
]
require 'fiddle'
require 'fiddle/import'

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

var (
	iphlpapi = windows.NewLazySystemDLL("IPHLPAPI.dll")
	procNotifyRouteChange = iphlpapi.NewProc("NotifyRouteChange")
)

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

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

typedef NotifyRouteChangeNative = Uint32 Function(Pointer<Void>, Pointer<Void>);
typedef NotifyRouteChangeDart = int Function(Pointer<Void>, Pointer<Void>);
final NotifyRouteChange = DynamicLibrary.open('IPHLPAPI.dll')
    .lookupFunction<NotifyRouteChangeNative, NotifyRouteChangeDart>('NotifyRouteChange');
// Handle : HANDLE* out -> Pointer<Void>
// overlapped : OVERLAPPED* -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function NotifyRouteChange(
  Handle: Pointer;   // HANDLE* out
  overlapped: Pointer   // OVERLAPPED*
): DWORD; stdcall;
  external 'IPHLPAPI.dll' name 'NotifyRouteChange';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "NotifyRouteChange"
  c_NotifyRouteChange :: Ptr () -> Ptr () -> IO Word32
-- Handle : HANDLE* out -> Ptr ()
-- overlapped : OVERLAPPED* -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let notifyroutechange =
  foreign "NotifyRouteChange"
    ((ptr void) @-> (ptr void) @-> returning uint32_t)
(* Handle : HANDLE* out -> (ptr void) *)
(* overlapped : OVERLAPPED* -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library iphlpapi (t "IPHLPAPI.dll"))
(cffi:use-foreign-library iphlpapi)

(cffi:defcfun ("NotifyRouteChange" notify-route-change :convention :stdcall) :uint32
  (handle :pointer)   ; HANDLE* out
  (overlapped :pointer))   ; OVERLAPPED*
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $NotifyRouteChange = Win32::API::More->new('IPHLPAPI',
    'DWORD NotifyRouteChange(HANDLE Handle, LPVOID overlapped)');
# my $ret = $NotifyRouteChange->Call($Handle, $overlapped);
# Handle : HANDLE* out -> HANDLE
# overlapped : OVERLAPPED* -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

類似 API
公式の関連項目
使用する型