ホーム › NetworkManagement.IpHelper › NotifyNetworkConnectivityHintChange
NotifyNetworkConnectivityHintChange
関数ネットワーク接続性ヒントの変更通知を登録する。
シグネチャ
// IPHLPAPI.dll
#include <windows.h>
WIN32_ERROR NotifyNetworkConnectivityHintChange(
PNETWORK_CONNECTIVITY_HINT_CHANGE_CALLBACK Callback,
void* CallerContext, // optional
BOOLEAN InitialNotification,
HANDLE* NotificationHandle
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| Callback | PNETWORK_CONNECTIVITY_HINT_CHANGE_CALLBACK | in | PNETWORK_CONNECTIVITY_HINT_CHANGE_CALLBACK 型の関数ポインターで、アプリケーション定義のコールバック関数を指します。このコールバック関数は、ネットワーク接続レベルまたはコストの変化が発生したときに呼び出されます。 |
| CallerContext | void* | inoptional | ユーザー固有の呼び出し元コンテキストです。このコンテキストはコールバック関数に渡されます。 |
| InitialNotification | BOOLEAN | in | 初期化通知を提供する場合は True、それ以外の場合は false です。 |
| NotificationHandle | HANDLE* | out | HANDLE へのポインターです。この関数は、その値に通知登録のハンドルを設定します。 |
戻り値の型: WIN32_ERROR
公式ドキュメント
集約されたネットワーク接続レベルおよびコストのヒントが変化したときに呼び出される、アプリケーション定義のコールバック関数を登録します。
戻り値
関数が成功した場合、戻り値は NO_ERROR です。それ以外の場合は、エラーコードが返されます。
解説(Remarks)
変更通知の登録を解除するには、CancelMibChangeNotify2 関数を呼び出し、NotifyNetworkConnectivityHintChange から返された NotificationHandle パラメーターを渡します。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// IPHLPAPI.dll
#include <windows.h>
WIN32_ERROR NotifyNetworkConnectivityHintChange(
PNETWORK_CONNECTIVITY_HINT_CHANGE_CALLBACK Callback,
void* CallerContext, // optional
BOOLEAN InitialNotification,
HANDLE* NotificationHandle
);[DllImport("IPHLPAPI.dll", ExactSpelling = true)]
static extern uint NotifyNetworkConnectivityHintChange(
IntPtr Callback, // PNETWORK_CONNECTIVITY_HINT_CHANGE_CALLBACK
IntPtr CallerContext, // void* optional
[MarshalAs(UnmanagedType.U1)] bool InitialNotification, // BOOLEAN
IntPtr NotificationHandle // HANDLE* out
);<DllImport("IPHLPAPI.dll", ExactSpelling:=True)>
Public Shared Function NotifyNetworkConnectivityHintChange(
Callback As IntPtr, ' PNETWORK_CONNECTIVITY_HINT_CHANGE_CALLBACK
CallerContext As IntPtr, ' void* optional
<MarshalAs(UnmanagedType.U1)> InitialNotification As Boolean, ' BOOLEAN
NotificationHandle As IntPtr ' HANDLE* out
) As UInteger
End Function' Callback : PNETWORK_CONNECTIVITY_HINT_CHANGE_CALLBACK
' CallerContext : void* optional
' InitialNotification : BOOLEAN
' NotificationHandle : HANDLE* out
Declare PtrSafe Function NotifyNetworkConnectivityHintChange Lib "iphlpapi" ( _
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
NotifyNetworkConnectivityHintChange = ctypes.windll.iphlpapi.NotifyNetworkConnectivityHintChange
NotifyNetworkConnectivityHintChange.restype = wintypes.DWORD
NotifyNetworkConnectivityHintChange.argtypes = [
ctypes.c_void_p, # Callback : PNETWORK_CONNECTIVITY_HINT_CHANGE_CALLBACK
ctypes.POINTER(None), # CallerContext : void* optional
wintypes.BOOLEAN, # InitialNotification : BOOLEAN
ctypes.c_void_p, # NotificationHandle : HANDLE* out
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('IPHLPAPI.dll')
NotifyNetworkConnectivityHintChange = Fiddle::Function.new(
lib['NotifyNetworkConnectivityHintChange'],
[
Fiddle::TYPE_VOIDP, # Callback : PNETWORK_CONNECTIVITY_HINT_CHANGE_CALLBACK
Fiddle::TYPE_VOIDP, # CallerContext : void* optional
Fiddle::TYPE_CHAR, # InitialNotification : BOOLEAN
Fiddle::TYPE_VOIDP, # NotificationHandle : HANDLE* out
],
-Fiddle::TYPE_INT)#[link(name = "iphlpapi")]
extern "system" {
fn NotifyNetworkConnectivityHintChange(
Callback: *const core::ffi::c_void, // PNETWORK_CONNECTIVITY_HINT_CHANGE_CALLBACK
CallerContext: *mut (), // void* optional
InitialNotification: u8, // BOOLEAN
NotificationHandle: *mut *mut core::ffi::c_void // HANDLE* out
) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("IPHLPAPI.dll")]
public static extern uint NotifyNetworkConnectivityHintChange(IntPtr Callback, IntPtr CallerContext, [MarshalAs(UnmanagedType.U1)] bool InitialNotification, IntPtr NotificationHandle);
"@
$api = Add-Type -MemberDefinition $sig -Name 'IPHLPAPI_NotifyNetworkConnectivityHintChange' -Namespace Win32 -PassThru
# $api::NotifyNetworkConnectivityHintChange(Callback, CallerContext, InitialNotification, NotificationHandle)#uselib "IPHLPAPI.dll"
#func global NotifyNetworkConnectivityHintChange "NotifyNetworkConnectivityHintChange" sptr, sptr, sptr, sptr
; NotifyNetworkConnectivityHintChange Callback, CallerContext, InitialNotification, NotificationHandle ; 戻り値は stat
; Callback : PNETWORK_CONNECTIVITY_HINT_CHANGE_CALLBACK -> "sptr"
; CallerContext : void* optional -> "sptr"
; InitialNotification : BOOLEAN -> "sptr"
; NotificationHandle : HANDLE* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "IPHLPAPI.dll"
#cfunc global NotifyNetworkConnectivityHintChange "NotifyNetworkConnectivityHintChange" sptr, sptr, int, sptr
; res = NotifyNetworkConnectivityHintChange(Callback, CallerContext, InitialNotification, NotificationHandle)
; Callback : PNETWORK_CONNECTIVITY_HINT_CHANGE_CALLBACK -> "sptr"
; CallerContext : void* optional -> "sptr"
; InitialNotification : BOOLEAN -> "int"
; NotificationHandle : HANDLE* out -> "sptr"; WIN32_ERROR NotifyNetworkConnectivityHintChange(PNETWORK_CONNECTIVITY_HINT_CHANGE_CALLBACK Callback, void* CallerContext, BOOLEAN InitialNotification, HANDLE* NotificationHandle)
#uselib "IPHLPAPI.dll"
#cfunc global NotifyNetworkConnectivityHintChange "NotifyNetworkConnectivityHintChange" intptr, intptr, int, intptr
; res = NotifyNetworkConnectivityHintChange(Callback, CallerContext, InitialNotification, NotificationHandle)
; Callback : PNETWORK_CONNECTIVITY_HINT_CHANGE_CALLBACK -> "intptr"
; CallerContext : void* optional -> "intptr"
; InitialNotification : BOOLEAN -> "int"
; NotificationHandle : HANDLE* out -> "intptr"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
iphlpapi = windows.NewLazySystemDLL("IPHLPAPI.dll")
procNotifyNetworkConnectivityHintChange = iphlpapi.NewProc("NotifyNetworkConnectivityHintChange")
)
// Callback (PNETWORK_CONNECTIVITY_HINT_CHANGE_CALLBACK), CallerContext (void* optional), InitialNotification (BOOLEAN), NotificationHandle (HANDLE* out)
r1, _, err := procNotifyNetworkConnectivityHintChange.Call(
uintptr(Callback),
uintptr(CallerContext),
uintptr(InitialNotification),
uintptr(NotificationHandle),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // WIN32_ERRORfunction NotifyNetworkConnectivityHintChange(
Callback: Pointer; // PNETWORK_CONNECTIVITY_HINT_CHANGE_CALLBACK
CallerContext: Pointer; // void* optional
InitialNotification: ByteBool; // BOOLEAN
NotificationHandle: Pointer // HANDLE* out
): DWORD; stdcall;
external 'IPHLPAPI.dll' name 'NotifyNetworkConnectivityHintChange';result := DllCall("IPHLPAPI\NotifyNetworkConnectivityHintChange"
, "Ptr", Callback ; PNETWORK_CONNECTIVITY_HINT_CHANGE_CALLBACK
, "Ptr", CallerContext ; void* optional
, "Char", InitialNotification ; BOOLEAN
, "Ptr", NotificationHandle ; HANDLE* out
, "UInt") ; return: WIN32_ERROR●NotifyNetworkConnectivityHintChange(Callback, CallerContext, InitialNotification, NotificationHandle) = DLL("IPHLPAPI.dll", "dword NotifyNetworkConnectivityHintChange(void*, void*, byte, void*)")
# 呼び出し: NotifyNetworkConnectivityHintChange(Callback, CallerContext, InitialNotification, NotificationHandle)
# Callback : PNETWORK_CONNECTIVITY_HINT_CHANGE_CALLBACK -> "void*"
# CallerContext : void* optional -> "void*"
# InitialNotification : BOOLEAN -> "byte"
# NotificationHandle : HANDLE* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "iphlpapi" fn NotifyNetworkConnectivityHintChange(
Callback: ?*anyopaque, // PNETWORK_CONNECTIVITY_HINT_CHANGE_CALLBACK
CallerContext: ?*anyopaque, // void* optional
InitialNotification: u8, // BOOLEAN
NotificationHandle: ?*anyopaque // HANDLE* out
) callconv(std.os.windows.WINAPI) u32;proc NotifyNetworkConnectivityHintChange(
Callback: pointer, # PNETWORK_CONNECTIVITY_HINT_CHANGE_CALLBACK
CallerContext: pointer, # void* optional
InitialNotification: uint8, # BOOLEAN
NotificationHandle: pointer # HANDLE* out
): uint32 {.importc: "NotifyNetworkConnectivityHintChange", stdcall, dynlib: "IPHLPAPI.dll".}pragma(lib, "iphlpapi");
extern(Windows)
uint NotifyNetworkConnectivityHintChange(
void* Callback, // PNETWORK_CONNECTIVITY_HINT_CHANGE_CALLBACK
void* CallerContext, // void* optional
ubyte InitialNotification, // BOOLEAN
void* NotificationHandle // HANDLE* out
);ccall((:NotifyNetworkConnectivityHintChange, "IPHLPAPI.dll"), stdcall, UInt32,
(Ptr{Cvoid}, Ptr{Cvoid}, UInt8, Ptr{Cvoid}),
Callback, CallerContext, InitialNotification, NotificationHandle)
# Callback : PNETWORK_CONNECTIVITY_HINT_CHANGE_CALLBACK -> Ptr{Cvoid}
# CallerContext : void* optional -> Ptr{Cvoid}
# InitialNotification : BOOLEAN -> UInt8
# NotificationHandle : HANDLE* out -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
uint32_t NotifyNetworkConnectivityHintChange(
void* Callback,
void* CallerContext,
uint8_t InitialNotification,
void* NotificationHandle);
]]
local iphlpapi = ffi.load("iphlpapi")
-- iphlpapi.NotifyNetworkConnectivityHintChange(Callback, CallerContext, InitialNotification, NotificationHandle)
-- Callback : PNETWORK_CONNECTIVITY_HINT_CHANGE_CALLBACK
-- CallerContext : void* optional
-- InitialNotification : BOOLEAN
-- NotificationHandle : HANDLE* out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('IPHLPAPI.dll');
const NotifyNetworkConnectivityHintChange = lib.func('__stdcall', 'NotifyNetworkConnectivityHintChange', 'uint32_t', ['void *', 'void *', 'uint8_t', 'void *']);
// NotifyNetworkConnectivityHintChange(Callback, CallerContext, InitialNotification, NotificationHandle)
// Callback : PNETWORK_CONNECTIVITY_HINT_CHANGE_CALLBACK -> 'void *'
// CallerContext : void* optional -> 'void *'
// InitialNotification : BOOLEAN -> 'uint8_t'
// NotificationHandle : HANDLE* out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
// コールバック(関数ポインタ)は koffi.proto/koffi.register で型を定義して渡す(素の void* では JS 関数を渡せない)。const lib = Deno.dlopen("IPHLPAPI.dll", {
NotifyNetworkConnectivityHintChange: { parameters: ["pointer", "pointer", "u8", "pointer"], result: "u32" },
});
// lib.symbols.NotifyNetworkConnectivityHintChange(Callback, CallerContext, InitialNotification, NotificationHandle)
// Callback : PNETWORK_CONNECTIVITY_HINT_CHANGE_CALLBACK -> "pointer"
// CallerContext : void* optional -> "pointer"
// InitialNotification : BOOLEAN -> "u8"
// NotificationHandle : HANDLE* out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
uint32_t NotifyNetworkConnectivityHintChange(
void* Callback,
void* CallerContext,
uint8_t InitialNotification,
void* NotificationHandle);
C, "IPHLPAPI.dll");
// $ffi->NotifyNetworkConnectivityHintChange(Callback, CallerContext, InitialNotification, NotificationHandle);
// Callback : PNETWORK_CONNECTIVITY_HINT_CHANGE_CALLBACK
// CallerContext : void* optional
// InitialNotification : BOOLEAN
// NotificationHandle : HANDLE* 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 NotifyNetworkConnectivityHintChange(
Callback Callback, // PNETWORK_CONNECTIVITY_HINT_CHANGE_CALLBACK
Pointer CallerContext, // void* optional
byte InitialNotification, // BOOLEAN
Pointer NotificationHandle // HANDLE* out
);
}@[Link("iphlpapi")]
lib LibIPHLPAPI
fun NotifyNetworkConnectivityHintChange = NotifyNetworkConnectivityHintChange(
Callback : Void*, # PNETWORK_CONNECTIVITY_HINT_CHANGE_CALLBACK
CallerContext : Void*, # void* optional
InitialNotification : UInt8, # BOOLEAN
NotificationHandle : Void* # HANDLE* out
) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef NotifyNetworkConnectivityHintChangeNative = Uint32 Function(Pointer<Void>, Pointer<Void>, Uint8, Pointer<Void>);
typedef NotifyNetworkConnectivityHintChangeDart = int Function(Pointer<Void>, Pointer<Void>, int, Pointer<Void>);
final NotifyNetworkConnectivityHintChange = DynamicLibrary.open('IPHLPAPI.dll')
.lookupFunction<NotifyNetworkConnectivityHintChangeNative, NotifyNetworkConnectivityHintChangeDart>('NotifyNetworkConnectivityHintChange');
// Callback : PNETWORK_CONNECTIVITY_HINT_CHANGE_CALLBACK -> Pointer<Void>
// CallerContext : void* optional -> Pointer<Void>
// InitialNotification : BOOLEAN -> Uint8
// NotificationHandle : HANDLE* out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function NotifyNetworkConnectivityHintChange(
Callback: Pointer; // PNETWORK_CONNECTIVITY_HINT_CHANGE_CALLBACK
CallerContext: Pointer; // void* optional
InitialNotification: ByteBool; // BOOLEAN
NotificationHandle: Pointer // HANDLE* out
): DWORD; stdcall;
external 'IPHLPAPI.dll' name 'NotifyNetworkConnectivityHintChange';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "NotifyNetworkConnectivityHintChange"
c_NotifyNetworkConnectivityHintChange :: Ptr () -> Ptr () -> Word8 -> Ptr () -> IO Word32
-- Callback : PNETWORK_CONNECTIVITY_HINT_CHANGE_CALLBACK -> Ptr ()
-- CallerContext : void* optional -> Ptr ()
-- InitialNotification : BOOLEAN -> Word8
-- NotificationHandle : HANDLE* out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let notifynetworkconnectivityhintchange =
foreign "NotifyNetworkConnectivityHintChange"
((ptr void) @-> (ptr void) @-> uint8_t @-> (ptr void) @-> returning uint32_t)
(* Callback : PNETWORK_CONNECTIVITY_HINT_CHANGE_CALLBACK -> (ptr void) *)
(* CallerContext : void* optional -> (ptr void) *)
(* InitialNotification : BOOLEAN -> uint8_t *)
(* NotificationHandle : HANDLE* 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 ("NotifyNetworkConnectivityHintChange" notify-network-connectivity-hint-change :convention :stdcall) :uint32
(callback :pointer) ; PNETWORK_CONNECTIVITY_HINT_CHANGE_CALLBACK
(caller-context :pointer) ; void* optional
(initial-notification :uint8) ; BOOLEAN
(notification-handle :pointer)) ; HANDLE* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $NotifyNetworkConnectivityHintChange = Win32::API::More->new('IPHLPAPI',
'DWORD NotifyNetworkConnectivityHintChange(LPVOID Callback, LPVOID CallerContext, BYTE InitialNotification, HANDLE NotificationHandle)');
# my $ret = $NotifyNetworkConnectivityHintChange->Call($Callback, $CallerContext, $InitialNotification, $NotificationHandle);
# Callback : PNETWORK_CONNECTIVITY_HINT_CHANGE_CALLBACK -> LPVOID
# CallerContext : void* optional -> LPVOID
# InitialNotification : BOOLEAN -> BYTE
# NotificationHandle : HANDLE* out -> HANDLE
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# コールバック(関数ポインタ)は Perl sub を直接渡せません。Win32::API::Callback を使用してください。