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

CancelMibChangeNotify2

関数
MIB変更通知の登録をキャンセルする。
DLLIPHLPAPI.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

WIN32_ERROR CancelMibChangeNotify2(
    HANDLE NotificationHandle
);

パラメーター

名前方向説明
NotificationHandleHANDLEinどの通知を取り消すかを示すために、通知の登録または取得を行う関数から返されたハンドル。

戻り値の型: WIN32_ERROR

公式ドキュメント

IP インターフェイスの変更、IP アドレスの変更、IP ルートの変更、Teredo ポートの変更、およびユニキャスト IP アドレス テーブルが安定して取得可能になったときの変更通知の登録を解除します。

戻り値

関数が成功した場合、戻り値は NO_ERROR です。

関数が失敗した場合、戻り値は次のいずれかのエラー コードです。

戻り値 説明
ERROR_INVALID_PARAMETER
無効なパラメーターが関数に渡されました。このエラーは、NotificationHandle パラメーターが NULL ポインターであった場合に返されます。
その他
返されたエラーのメッセージ文字列を取得するには、 FormatMessage を使用してください。

解説(Remarks)

CancelMibChangeNotify2 関数は、Windows Vista 以降で定義されています。

CancelMibChangeNotify2 関数は、ローカル コンピューター上で以前に要求された IP インターフェイスの変更、IP アドレスの変更、IP ルートの変更、または Teredo ポートの変更に対する変更通知の登録を解除します。これらの要求は、NotifyIpInterfaceChangeNotifyUnicastIpAddressChangeNotifyRouteChange2、または NotifyTeredoPortChange を呼び出すことで行われます。CancelMibChangeNotify2 関数は、ローカル コンピューター上でユニキャスト IP アドレス テーブルが安定して取得可能になったときに通知を受け取るための以前の要求も取り消します。この要求は、NotifyStableUnicastIpAddressTable 関数を呼び出すことで行われます。

これらの通知関数に返された NotificationHandle パラメーターは、通知の登録を解除する、または安定したユニキャスト IP アドレス テーブルを取得する保留中の要求を取り消すために、CancelMibChangeNotify2 に渡されます。

アプリケーションは、同じ NotificationHandle パラメーターに対する通知コールバック関数を現在実行しているスレッドのコンテキストから CancelMibChangeNotify2 関数を呼び出すことはできません。これを行うと、そのコールバックを実行しているスレッドはデッドロックに陥ります。したがって、CancelMibChangeNotify2 関数は、通知コールバック ルーチンの一部として直接呼び出してはなりません。より一般的な状況では、CancelMibChangeNotify2 関数を実行するスレッドは、通知コールバック処理を実行するスレッドが待機するリソースを所有することはできません。同様のデッドロックが発生するためです。CancelMibChangeNotify2 関数は、通知コールバックを受け取るスレッドが依存関係を持たない別のスレッドから呼び出す必要があります。

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

各言語での呼び出し定義

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

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

CancelMibChangeNotify2 = ctypes.windll.iphlpapi.CancelMibChangeNotify2
CancelMibChangeNotify2.restype = wintypes.DWORD
CancelMibChangeNotify2.argtypes = [
    wintypes.HANDLE,  # NotificationHandle : HANDLE
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('IPHLPAPI.dll')
CancelMibChangeNotify2 = Fiddle::Function.new(
  lib['CancelMibChangeNotify2'],
  [
    Fiddle::TYPE_VOIDP,  # NotificationHandle : HANDLE
  ],
  -Fiddle::TYPE_INT)
#[link(name = "iphlpapi")]
extern "system" {
    fn CancelMibChangeNotify2(
        NotificationHandle: *mut core::ffi::c_void  // HANDLE
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("IPHLPAPI.dll")]
public static extern uint CancelMibChangeNotify2(IntPtr NotificationHandle);
"@
$api = Add-Type -MemberDefinition $sig -Name 'IPHLPAPI_CancelMibChangeNotify2' -Namespace Win32 -PassThru
# $api::CancelMibChangeNotify2(NotificationHandle)
#uselib "IPHLPAPI.dll"
#func global CancelMibChangeNotify2 "CancelMibChangeNotify2" sptr
; CancelMibChangeNotify2 NotificationHandle   ; 戻り値は stat
; NotificationHandle : HANDLE -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "IPHLPAPI.dll"
#cfunc global CancelMibChangeNotify2 "CancelMibChangeNotify2" sptr
; res = CancelMibChangeNotify2(NotificationHandle)
; NotificationHandle : HANDLE -> "sptr"
; WIN32_ERROR CancelMibChangeNotify2(HANDLE NotificationHandle)
#uselib "IPHLPAPI.dll"
#cfunc global CancelMibChangeNotify2 "CancelMibChangeNotify2" intptr
; res = CancelMibChangeNotify2(NotificationHandle)
; NotificationHandle : HANDLE -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	iphlpapi = windows.NewLazySystemDLL("IPHLPAPI.dll")
	procCancelMibChangeNotify2 = iphlpapi.NewProc("CancelMibChangeNotify2")
)

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

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

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

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

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

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

関連項目

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