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

CancelIPChangeNotify

関数
IPアドレスや経路変更の通知登録を解除する。
DLLIPHLPAPI.dll呼出規約winapi対応OSWindows XP 以降

シグネチャ

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

BOOL CancelIPChangeNotify(
    OVERLAPPED* notifyOverlapped
);

パラメーター

名前方向説明
notifyOverlappedOVERLAPPED*in直前の NotifyAddrChange または NotifyRouteChange の呼び出しで使用した OVERLAPPED 構造体へのポインターです。

戻り値の型: BOOL

公式ドキュメント

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

解説(Remarks)

CancelIPChangeNotify 関数は、ローカルコンピューター上の IPv4 アドレスまたはルートの変更について、以前に要求した変更通知の登録を解除します。これらの通知登録の要求は、NotifyAddrChange または NotifyRouteChange 関数を呼び出すことで行われます。

これらの通知関数の直前の呼び出しで使用した OVERLAPPED 構造体を、通知の登録を解除するために notifyOverlapped パラメーターとして CancelIPChangeNotify 関数に渡します。

通知要求が見つからなかった場合、または無効な notifyOverlapped パラメーターが渡された場合、CancelIPChangeNotifyFALSE を返すことがあります。

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

各言語での呼び出し定義

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

BOOL CancelIPChangeNotify(
    OVERLAPPED* notifyOverlapped
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("IPHLPAPI.dll", ExactSpelling = true)]
static extern bool CancelIPChangeNotify(
    IntPtr notifyOverlapped   // OVERLAPPED*
);
<DllImport("IPHLPAPI.dll", ExactSpelling:=True)>
Public Shared Function CancelIPChangeNotify(
    notifyOverlapped As IntPtr   ' OVERLAPPED*
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' notifyOverlapped : OVERLAPPED*
Declare PtrSafe Function CancelIPChangeNotify Lib "iphlpapi" ( _
    ByVal notifyOverlapped As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

CancelIPChangeNotify = ctypes.windll.iphlpapi.CancelIPChangeNotify
CancelIPChangeNotify.restype = wintypes.BOOL
CancelIPChangeNotify.argtypes = [
    ctypes.c_void_p,  # notifyOverlapped : OVERLAPPED*
]
require 'fiddle'
require 'fiddle/import'

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

var (
	iphlpapi = windows.NewLazySystemDLL("IPHLPAPI.dll")
	procCancelIPChangeNotify = iphlpapi.NewProc("CancelIPChangeNotify")
)

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

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

typedef CancelIPChangeNotifyNative = Int32 Function(Pointer<Void>);
typedef CancelIPChangeNotifyDart = int Function(Pointer<Void>);
final CancelIPChangeNotify = DynamicLibrary.open('IPHLPAPI.dll')
    .lookupFunction<CancelIPChangeNotifyNative, CancelIPChangeNotifyDart>('CancelIPChangeNotify');
// notifyOverlapped : OVERLAPPED* -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function CancelIPChangeNotify(
  notifyOverlapped: Pointer   // OVERLAPPED*
): BOOL; stdcall;
  external 'IPHLPAPI.dll' name 'CancelIPChangeNotify';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "CancelIPChangeNotify"
  c_CancelIPChangeNotify :: Ptr () -> IO CInt
-- notifyOverlapped : OVERLAPPED* -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let cancelipchangenotify =
  foreign "CancelIPChangeNotify"
    ((ptr void) @-> returning int32_t)
(* notifyOverlapped : 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 ("CancelIPChangeNotify" cancel-ipchange-notify :convention :stdcall) :int32
  (notify-overlapped :pointer))   ; OVERLAPPED*
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $CancelIPChangeNotify = Win32::API::More->new('IPHLPAPI',
    'BOOL CancelIPChangeNotify(LPVOID notifyOverlapped)');
# my $ret = $CancelIPChangeNotify->Call($notifyOverlapped);
# notifyOverlapped : OVERLAPPED* -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

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