NotifyUnicastIpAddressChange
関数シグネチャ
// IPHLPAPI.dll
#include <windows.h>
WIN32_ERROR NotifyUnicastIpAddressChange(
ADDRESS_FAMILY Family,
PUNICAST_IPADDRESS_CHANGE_CALLBACK Callback,
void* CallerContext, // optional
BOOLEAN InitialNotification,
HANDLE* NotificationHandle
);パラメーター
| 名前 | 型 | 方向 | 説明 | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Family | ADDRESS_FAMILY | in | 変更通知を登録するアドレスファミリーです。 アドレスファミリーに指定可能な値は、Winsock2.h ヘッダーファイルに一覧されています。AF_ アドレスファミリー定数と PF_ プロトコルファミリー定数の値は同一である(たとえば AF_INET と PF_INET)ため、いずれの定数も使用できます。 Windows Vista 以降向けにリリースされた Windows SDK では、ヘッダーファイルの構成が変更されており、このメンバーに指定可能な値は Ws2def.h ヘッダーファイルで定義されています。Ws2def.h ヘッダーファイルは Winsock2.h に自動的にインクルードされるため、直接使用しないでください。 現在サポートされている値は AF_INET、AF_INET6、AF_UNSPEC です。
| ||||||||
| Callback | PUNICAST_IPADDRESS_CHANGE_CALLBACK | in | 変更が発生したときに呼び出す関数へのポインターです。この関数は、ユニキャスト IP アドレスの通知を受信したときに呼び出されます。 | ||||||||
| CallerContext | void* | inoptional | インターフェイス通知を受信したときに、Callback パラメーターで指定したコールバック関数に渡されるユーザーコンテキストです。 | ||||||||
| InitialNotification | BOOLEAN | in | 変更通知の登録が完了した直後にコールバックを呼び出すかどうかを示す値です。この初回通知は、ユニキャスト IP アドレスに変更が発生したことを示すものではありません。このパラメーターの目的は、コールバックが登録されたことの確認を提供することです。 | ||||||||
| NotificationHandle | HANDLE* | inout | 後で変更通知の登録を解除するために使用できるハンドルを返すためのポインターです。成功した場合、このパラメーターに通知ハンドルが返されます。エラーが発生した場合は NULL が返されます。 |
戻り値の型: WIN32_ERROR
公式ドキュメント
ローカルコンピューター上のすべてのユニキャスト IP インターフェイス、ユニキャスト IPv4 アドレス、またはユニキャスト IPv6 アドレスに対する変更の通知を登録します。
戻り値
関数が成功した場合、戻り値は NO_ERROR です。
関数が失敗した場合、戻り値は次のいずれかのエラーコードです。
| 戻りコード | 説明 |
|---|---|
| 無効なハンドルが検出される内部エラーが発生しました。 | |
| 無効なパラメーターが関数に渡されました。このエラーは、Family パラメーターが AF_INET、AF_INET6、AF_UNSPEC のいずれでもない場合に返されます。 | |
| メモリが不足していました。 | |
|
FormatMessage を使用して、返されたエラーのメッセージ文字列を取得してください。 |
解説(Remarks)
NotifyUnicastIpAddressChange 関数は Windows Vista 以降で定義されています。
Family パラメーターには AF_INET、AF_INET6、AF_UNSPEC のいずれかを設定する必要があります。
Callback パラメーターで指定したコールバック関数の呼び出しはシリアライズされます。コールバック関数は VOID 型の関数として定義する必要があります。コールバック関数に渡されるパラメーターには次のものがあります。
| パラメーター | 説明 |
|---|---|
| IN PVOID CallerContext | 通知の登録時に NotifyUnicastIpAddressChange 関数に渡された CallerContext パラメーターです。 |
| IN PMIB_UNICASTIPADDRESS_ROW Row OPTIONAL | 変更されたユニキャスト IP アドレスの MIB_UNICASTIPADDRESS_ROW エントリへのポインターです。コールバック関数の NotificationType パラメーターに渡される MIB_NOTIFICATION_TYPE 値が MibInitialNotification に設定されている場合、このパラメーターは NULL ポインターになります。これは、通知の登録時に NotifyUnicastIpAddressChange に渡された InitialNotification パラメーターが TRUE に設定されていた場合にのみ発生します。 |
| IN MIB_NOTIFICATION_TYPE NotificationType | 通知の種類です。このメンバーには、Netioapi.h ヘッダーファイルで定義されている MIB_NOTIFICATION_TYPE 列挙型の値のいずれかを指定できます。 |
Callback パラメーターで指定するコールバック関数は、NotifyUnicastIpAddressChange 関数を呼び出すアプリケーションと同じプロセス内に実装する必要があります。コールバック関数が別の DLL にある場合は、変更通知を登録するために NotifyUnicastIpAddressChange 関数を呼び出す前に、その DLL を読み込んでおく必要があります。
変更発生時にコールバック関数が受信され、Row パラメーターが NULL でない場合、Row パラメーターで渡される MIB_UNICASTIPADDRESS_ROW 構造体へのポインターには不完全なデータが含まれています。MIB_UNICASTIPADDRESS_ROW 構造体で返される情報は、変更された IP アドレスに関する完全な情報を照会するためにアプリケーションが GetUnicastIpAddressEntry 関数を呼び出すのに十分な情報のみです。コールバック関数を受信した際、アプリケーションは MIB_UNICASTIPADDRESS_ROW 構造体を割り当て、受信した Row パラメーターが指す MIB_UNICASTIPADDRESS_ROW 構造体内の Address、InterfaceLuid、InterfaceIndex の各メンバーで初期化する必要があります。この新しく初期化した MIB_UNICASTIPADDRESS_ROW 構造体へのポインターを GetUnicastIpAddressEntry 関数に渡すことで、変更されたユニキャスト IP アドレスに関する完全な情報を取得できます。
コールバック通知で使用される Row パラメーターが指すメモリは、オペレーティングシステムによって管理されます。通知を受信したアプリケーションは、Row パラメーターが指すメモリを解放しようとしてはなりません。
変更通知を登録するために NotifyUnicastIpAddressChange 関数が呼び出されると、アプリケーションが変更通知の登録を解除するか、アプリケーションが終了するまで、これらの通知は送信され続けます。アプリケーションが終了した場合、システムは変更通知の登録を自動的に解除します。ただし、アプリケーションは終了前に変更通知の登録を明示的に解除することが推奨されます。
変更通知の登録は、システムがシャットダウンまたは再起動された場合には保持されません。
変更通知の登録を解除するには、NotifyUnicastIpAddressChange によって返された NotificationHandle パラメーターを渡して CancelMibChangeNotify2 関数を呼び出します。
アプリケーションは、同じ NotificationHandle パラメーターに対する通知コールバック関数を現在実行中のスレッドのコンテキストから CancelMibChangeNotify2 関数を呼び出すことはできません。さもなければ、そのコールバックを実行しているスレッドはデッドロックに陥ります。したがって、CancelMibChangeNotify2 関数を通知コールバックルーチンの一部として直接呼び出してはなりません。より一般的な状況では、CancelMibChangeNotify2 関数を実行するスレッドは、通知コールバック処理を実行するスレッドが待機するようなリソースを所有してはなりません。同様のデッドロックを引き起こすためです。CancelMibChangeNotify2 関数は別のスレッドから呼び出す必要があり、そのスレッドは通知コールバックを受信するスレッドに依存していてはなりません。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// IPHLPAPI.dll
#include <windows.h>
WIN32_ERROR NotifyUnicastIpAddressChange(
ADDRESS_FAMILY Family,
PUNICAST_IPADDRESS_CHANGE_CALLBACK Callback,
void* CallerContext, // optional
BOOLEAN InitialNotification,
HANDLE* NotificationHandle
);[DllImport("IPHLPAPI.dll", ExactSpelling = true)]
static extern uint NotifyUnicastIpAddressChange(
ushort Family, // ADDRESS_FAMILY
IntPtr Callback, // PUNICAST_IPADDRESS_CHANGE_CALLBACK
IntPtr CallerContext, // void* optional
[MarshalAs(UnmanagedType.U1)] bool InitialNotification, // BOOLEAN
IntPtr NotificationHandle // HANDLE* in/out
);<DllImport("IPHLPAPI.dll", ExactSpelling:=True)>
Public Shared Function NotifyUnicastIpAddressChange(
Family As UShort, ' ADDRESS_FAMILY
Callback As IntPtr, ' PUNICAST_IPADDRESS_CHANGE_CALLBACK
CallerContext As IntPtr, ' void* optional
<MarshalAs(UnmanagedType.U1)> InitialNotification As Boolean, ' BOOLEAN
NotificationHandle As IntPtr ' HANDLE* in/out
) As UInteger
End Function' Family : ADDRESS_FAMILY
' Callback : PUNICAST_IPADDRESS_CHANGE_CALLBACK
' CallerContext : void* optional
' InitialNotification : BOOLEAN
' NotificationHandle : HANDLE* in/out
Declare PtrSafe Function NotifyUnicastIpAddressChange Lib "iphlpapi" ( _
ByVal Family As Integer, _
ByVal Callback As LongPtr, _
ByVal CallerContext As LongPtr, _
ByVal InitialNotification As Byte, _
ByVal NotificationHandle As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
NotifyUnicastIpAddressChange = ctypes.windll.iphlpapi.NotifyUnicastIpAddressChange
NotifyUnicastIpAddressChange.restype = wintypes.DWORD
NotifyUnicastIpAddressChange.argtypes = [
ctypes.c_ushort, # Family : ADDRESS_FAMILY
ctypes.c_void_p, # Callback : PUNICAST_IPADDRESS_CHANGE_CALLBACK
ctypes.POINTER(None), # CallerContext : void* optional
wintypes.BOOLEAN, # InitialNotification : BOOLEAN
ctypes.c_void_p, # NotificationHandle : HANDLE* in/out
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('IPHLPAPI.dll')
NotifyUnicastIpAddressChange = Fiddle::Function.new(
lib['NotifyUnicastIpAddressChange'],
[
-Fiddle::TYPE_SHORT, # Family : ADDRESS_FAMILY
Fiddle::TYPE_VOIDP, # Callback : PUNICAST_IPADDRESS_CHANGE_CALLBACK
Fiddle::TYPE_VOIDP, # CallerContext : void* optional
Fiddle::TYPE_CHAR, # InitialNotification : BOOLEAN
Fiddle::TYPE_VOIDP, # NotificationHandle : HANDLE* in/out
],
-Fiddle::TYPE_INT)#[link(name = "iphlpapi")]
extern "system" {
fn NotifyUnicastIpAddressChange(
Family: u16, // ADDRESS_FAMILY
Callback: *const core::ffi::c_void, // PUNICAST_IPADDRESS_CHANGE_CALLBACK
CallerContext: *mut (), // void* optional
InitialNotification: u8, // BOOLEAN
NotificationHandle: *mut *mut core::ffi::c_void // HANDLE* in/out
) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("IPHLPAPI.dll")]
public static extern uint NotifyUnicastIpAddressChange(ushort Family, IntPtr Callback, IntPtr CallerContext, [MarshalAs(UnmanagedType.U1)] bool InitialNotification, IntPtr NotificationHandle);
"@
$api = Add-Type -MemberDefinition $sig -Name 'IPHLPAPI_NotifyUnicastIpAddressChange' -Namespace Win32 -PassThru
# $api::NotifyUnicastIpAddressChange(Family, Callback, CallerContext, InitialNotification, NotificationHandle)#uselib "IPHLPAPI.dll"
#func global NotifyUnicastIpAddressChange "NotifyUnicastIpAddressChange" sptr, sptr, sptr, sptr, sptr
; NotifyUnicastIpAddressChange Family, Callback, CallerContext, InitialNotification, NotificationHandle ; 戻り値は stat
; Family : ADDRESS_FAMILY -> "sptr"
; Callback : PUNICAST_IPADDRESS_CHANGE_CALLBACK -> "sptr"
; CallerContext : void* optional -> "sptr"
; InitialNotification : BOOLEAN -> "sptr"
; NotificationHandle : HANDLE* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "IPHLPAPI.dll"
#cfunc global NotifyUnicastIpAddressChange "NotifyUnicastIpAddressChange" int, sptr, sptr, int, sptr
; res = NotifyUnicastIpAddressChange(Family, Callback, CallerContext, InitialNotification, NotificationHandle)
; Family : ADDRESS_FAMILY -> "int"
; Callback : PUNICAST_IPADDRESS_CHANGE_CALLBACK -> "sptr"
; CallerContext : void* optional -> "sptr"
; InitialNotification : BOOLEAN -> "int"
; NotificationHandle : HANDLE* in/out -> "sptr"; WIN32_ERROR NotifyUnicastIpAddressChange(ADDRESS_FAMILY Family, PUNICAST_IPADDRESS_CHANGE_CALLBACK Callback, void* CallerContext, BOOLEAN InitialNotification, HANDLE* NotificationHandle)
#uselib "IPHLPAPI.dll"
#cfunc global NotifyUnicastIpAddressChange "NotifyUnicastIpAddressChange" int, intptr, intptr, int, intptr
; res = NotifyUnicastIpAddressChange(Family, Callback, CallerContext, InitialNotification, NotificationHandle)
; Family : ADDRESS_FAMILY -> "int"
; Callback : PUNICAST_IPADDRESS_CHANGE_CALLBACK -> "intptr"
; CallerContext : void* optional -> "intptr"
; InitialNotification : BOOLEAN -> "int"
; NotificationHandle : HANDLE* in/out -> "intptr"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
iphlpapi = windows.NewLazySystemDLL("IPHLPAPI.dll")
procNotifyUnicastIpAddressChange = iphlpapi.NewProc("NotifyUnicastIpAddressChange")
)
// Family (ADDRESS_FAMILY), Callback (PUNICAST_IPADDRESS_CHANGE_CALLBACK), CallerContext (void* optional), InitialNotification (BOOLEAN), NotificationHandle (HANDLE* in/out)
r1, _, err := procNotifyUnicastIpAddressChange.Call(
uintptr(Family),
uintptr(Callback),
uintptr(CallerContext),
uintptr(InitialNotification),
uintptr(NotificationHandle),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // WIN32_ERRORfunction NotifyUnicastIpAddressChange(
Family: Word; // ADDRESS_FAMILY
Callback: Pointer; // PUNICAST_IPADDRESS_CHANGE_CALLBACK
CallerContext: Pointer; // void* optional
InitialNotification: ByteBool; // BOOLEAN
NotificationHandle: Pointer // HANDLE* in/out
): DWORD; stdcall;
external 'IPHLPAPI.dll' name 'NotifyUnicastIpAddressChange';result := DllCall("IPHLPAPI\NotifyUnicastIpAddressChange"
, "UShort", Family ; ADDRESS_FAMILY
, "Ptr", Callback ; PUNICAST_IPADDRESS_CHANGE_CALLBACK
, "Ptr", CallerContext ; void* optional
, "Char", InitialNotification ; BOOLEAN
, "Ptr", NotificationHandle ; HANDLE* in/out
, "UInt") ; return: WIN32_ERROR●NotifyUnicastIpAddressChange(Family, Callback, CallerContext, InitialNotification, NotificationHandle) = DLL("IPHLPAPI.dll", "dword NotifyUnicastIpAddressChange(int, void*, void*, byte, void*)")
# 呼び出し: NotifyUnicastIpAddressChange(Family, Callback, CallerContext, InitialNotification, NotificationHandle)
# Family : ADDRESS_FAMILY -> "int"
# Callback : PUNICAST_IPADDRESS_CHANGE_CALLBACK -> "void*"
# CallerContext : void* optional -> "void*"
# InitialNotification : BOOLEAN -> "byte"
# NotificationHandle : HANDLE* in/out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "iphlpapi" fn NotifyUnicastIpAddressChange(
Family: u16, // ADDRESS_FAMILY
Callback: ?*anyopaque, // PUNICAST_IPADDRESS_CHANGE_CALLBACK
CallerContext: ?*anyopaque, // void* optional
InitialNotification: u8, // BOOLEAN
NotificationHandle: ?*anyopaque // HANDLE* in/out
) callconv(std.os.windows.WINAPI) u32;proc NotifyUnicastIpAddressChange(
Family: uint16, # ADDRESS_FAMILY
Callback: pointer, # PUNICAST_IPADDRESS_CHANGE_CALLBACK
CallerContext: pointer, # void* optional
InitialNotification: uint8, # BOOLEAN
NotificationHandle: pointer # HANDLE* in/out
): uint32 {.importc: "NotifyUnicastIpAddressChange", stdcall, dynlib: "IPHLPAPI.dll".}pragma(lib, "iphlpapi");
extern(Windows)
uint NotifyUnicastIpAddressChange(
ushort Family, // ADDRESS_FAMILY
void* Callback, // PUNICAST_IPADDRESS_CHANGE_CALLBACK
void* CallerContext, // void* optional
ubyte InitialNotification, // BOOLEAN
void* NotificationHandle // HANDLE* in/out
);ccall((:NotifyUnicastIpAddressChange, "IPHLPAPI.dll"), stdcall, UInt32,
(UInt16, Ptr{Cvoid}, Ptr{Cvoid}, UInt8, Ptr{Cvoid}),
Family, Callback, CallerContext, InitialNotification, NotificationHandle)
# Family : ADDRESS_FAMILY -> UInt16
# Callback : PUNICAST_IPADDRESS_CHANGE_CALLBACK -> Ptr{Cvoid}
# CallerContext : void* optional -> Ptr{Cvoid}
# InitialNotification : BOOLEAN -> UInt8
# NotificationHandle : HANDLE* in/out -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
uint32_t NotifyUnicastIpAddressChange(
uint16_t Family,
void* Callback,
void* CallerContext,
uint8_t InitialNotification,
void* NotificationHandle);
]]
local iphlpapi = ffi.load("iphlpapi")
-- iphlpapi.NotifyUnicastIpAddressChange(Family, Callback, CallerContext, InitialNotification, NotificationHandle)
-- Family : ADDRESS_FAMILY
-- Callback : PUNICAST_IPADDRESS_CHANGE_CALLBACK
-- CallerContext : void* optional
-- InitialNotification : BOOLEAN
-- NotificationHandle : HANDLE* in/out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('IPHLPAPI.dll');
const NotifyUnicastIpAddressChange = lib.func('__stdcall', 'NotifyUnicastIpAddressChange', 'uint32_t', ['uint16_t', 'void *', 'void *', 'uint8_t', 'void *']);
// NotifyUnicastIpAddressChange(Family, Callback, CallerContext, InitialNotification, NotificationHandle)
// Family : ADDRESS_FAMILY -> 'uint16_t'
// Callback : PUNICAST_IPADDRESS_CHANGE_CALLBACK -> 'void *'
// CallerContext : void* optional -> 'void *'
// InitialNotification : BOOLEAN -> 'uint8_t'
// NotificationHandle : HANDLE* in/out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
// コールバック(関数ポインタ)は koffi.proto/koffi.register で型を定義して渡す(素の void* では JS 関数を渡せない)。const lib = Deno.dlopen("IPHLPAPI.dll", {
NotifyUnicastIpAddressChange: { parameters: ["u16", "pointer", "pointer", "u8", "pointer"], result: "u32" },
});
// lib.symbols.NotifyUnicastIpAddressChange(Family, Callback, CallerContext, InitialNotification, NotificationHandle)
// Family : ADDRESS_FAMILY -> "u16"
// Callback : PUNICAST_IPADDRESS_CHANGE_CALLBACK -> "pointer"
// CallerContext : void* optional -> "pointer"
// InitialNotification : BOOLEAN -> "u8"
// NotificationHandle : HANDLE* in/out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
uint32_t NotifyUnicastIpAddressChange(
uint16_t Family,
void* Callback,
void* CallerContext,
uint8_t InitialNotification,
void* NotificationHandle);
C, "IPHLPAPI.dll");
// $ffi->NotifyUnicastIpAddressChange(Family, Callback, CallerContext, InitialNotification, NotificationHandle);
// Family : ADDRESS_FAMILY
// Callback : PUNICAST_IPADDRESS_CHANGE_CALLBACK
// CallerContext : void* optional
// InitialNotification : BOOLEAN
// NotificationHandle : HANDLE* 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 Iphlpapi extends StdCallLibrary {
Iphlpapi INSTANCE = Native.load("iphlpapi", Iphlpapi.class);
int NotifyUnicastIpAddressChange(
short Family, // ADDRESS_FAMILY
Callback Callback, // PUNICAST_IPADDRESS_CHANGE_CALLBACK
Pointer CallerContext, // void* optional
byte InitialNotification, // BOOLEAN
Pointer NotificationHandle // HANDLE* in/out
);
}@[Link("iphlpapi")]
lib LibIPHLPAPI
fun NotifyUnicastIpAddressChange = NotifyUnicastIpAddressChange(
Family : UInt16, # ADDRESS_FAMILY
Callback : Void*, # PUNICAST_IPADDRESS_CHANGE_CALLBACK
CallerContext : Void*, # void* optional
InitialNotification : UInt8, # BOOLEAN
NotificationHandle : Void* # HANDLE* 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 NotifyUnicastIpAddressChangeNative = Uint32 Function(Uint16, Pointer<Void>, Pointer<Void>, Uint8, Pointer<Void>);
typedef NotifyUnicastIpAddressChangeDart = int Function(int, Pointer<Void>, Pointer<Void>, int, Pointer<Void>);
final NotifyUnicastIpAddressChange = DynamicLibrary.open('IPHLPAPI.dll')
.lookupFunction<NotifyUnicastIpAddressChangeNative, NotifyUnicastIpAddressChangeDart>('NotifyUnicastIpAddressChange');
// Family : ADDRESS_FAMILY -> Uint16
// Callback : PUNICAST_IPADDRESS_CHANGE_CALLBACK -> Pointer<Void>
// CallerContext : void* optional -> Pointer<Void>
// InitialNotification : BOOLEAN -> Uint8
// NotificationHandle : HANDLE* in/out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function NotifyUnicastIpAddressChange(
Family: Word; // ADDRESS_FAMILY
Callback: Pointer; // PUNICAST_IPADDRESS_CHANGE_CALLBACK
CallerContext: Pointer; // void* optional
InitialNotification: ByteBool; // BOOLEAN
NotificationHandle: Pointer // HANDLE* in/out
): DWORD; stdcall;
external 'IPHLPAPI.dll' name 'NotifyUnicastIpAddressChange';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "NotifyUnicastIpAddressChange"
c_NotifyUnicastIpAddressChange :: Word16 -> Ptr () -> Ptr () -> Word8 -> Ptr () -> IO Word32
-- Family : ADDRESS_FAMILY -> Word16
-- Callback : PUNICAST_IPADDRESS_CHANGE_CALLBACK -> Ptr ()
-- CallerContext : void* optional -> Ptr ()
-- InitialNotification : BOOLEAN -> Word8
-- NotificationHandle : HANDLE* in/out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let notifyunicastipaddresschange =
foreign "NotifyUnicastIpAddressChange"
(uint16_t @-> (ptr void) @-> (ptr void) @-> uint8_t @-> (ptr void) @-> returning uint32_t)
(* Family : ADDRESS_FAMILY -> uint16_t *)
(* Callback : PUNICAST_IPADDRESS_CHANGE_CALLBACK -> (ptr void) *)
(* CallerContext : void* optional -> (ptr void) *)
(* InitialNotification : BOOLEAN -> uint8_t *)
(* NotificationHandle : HANDLE* in/out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library iphlpapi (t "IPHLPAPI.dll"))
(cffi:use-foreign-library iphlpapi)
(cffi:defcfun ("NotifyUnicastIpAddressChange" notify-unicast-ip-address-change :convention :stdcall) :uint32
(family :uint16) ; ADDRESS_FAMILY
(callback :pointer) ; PUNICAST_IPADDRESS_CHANGE_CALLBACK
(caller-context :pointer) ; void* optional
(initial-notification :uint8) ; BOOLEAN
(notification-handle :pointer)) ; HANDLE* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $NotifyUnicastIpAddressChange = Win32::API::More->new('IPHLPAPI',
'DWORD NotifyUnicastIpAddressChange(WORD Family, LPVOID Callback, LPVOID CallerContext, BYTE InitialNotification, HANDLE NotificationHandle)');
# my $ret = $NotifyUnicastIpAddressChange->Call($Family, $Callback, $CallerContext, $InitialNotification, $NotificationHandle);
# Family : ADDRESS_FAMILY -> WORD
# Callback : PUNICAST_IPADDRESS_CHANGE_CALLBACK -> LPVOID
# CallerContext : void* optional -> LPVOID
# InitialNotification : BOOLEAN -> BYTE
# NotificationHandle : HANDLE* in/out -> HANDLE
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# コールバック(関数ポインタ)は Perl sub を直接渡せません。Win32::API::Callback を使用してください。関連項目
- f CancelMibChangeNotify2 — MIB変更通知の登録をキャンセルする。
- f CreateUnicastIpAddressEntry — インターフェイスに新しいユニキャストIPアドレスを追加する。
- f DeleteUnicastIpAddressEntry — 指定したユニキャストIPアドレスエントリを削除する。
- f GetUnicastIpAddressEntry — 指定したユニキャストIPアドレスの情報を取得する。
- f GetUnicastIpAddressTable — ユニキャストIPアドレスの一覧テーブルを取得する。
- f InitializeUnicastIpAddressEntry — ユニキャストIPアドレス行構造体を既定値で初期化する。
- e MIB_NOTIFICATION_TYPE
- s MIB_UNICASTIPADDRESS_ROW
- s MIB_UNICASTIPADDRESS_TABLE
- f NotifyStableUnicastIpAddressTable — 安定したユニキャストIPアドレステーブルを取得し通知登録する。
- f SetUnicastIpAddressEntry — 指定したユニキャストIPアドレスエントリを設定する。