CancelIPChangeNotify function (iphlpapi.h)

Article
02/22/2024

The CancelIPChangeNotify function cancels notification of IPv4 address and route changes previously requested with successful calls to the NotifyAddrChange or NotifyRouteChange functions.

Syntax

IPHLPAPI_DLL_LINKAGE BOOL CancelIPChangeNotify(
  [in] LPOVERLAPPED notifyOverlapped
);

Parameters

[in] notifyOverlapped

A pointer to the OVERLAPPED structure used in the previous call to NotifyAddrChange or NotifyRouteChange.

Return value

None

Remarks

The
CancelIPChangeNotify function deregisters for a change notification previously requested for IPv4 address or route changes on a local computer. These requests to register for notification are made by calling the NotifyAddrChange or NotifyRouteChange functions.

The OVERLAPPED structure used in the previous call to one of these notification functions is passed to CancelIPChangeNotify function in the notifyOverlapped parameter to deregister for notifications.

The CancelIPChangeNotify can return FALSE if no notification request was found or an invalid notifyOverlapped parameter was passed.

Requirements

Requirement	Value
Minimum supported client	Windows XP [desktop apps only]
Minimum supported server	Windows Server 2003 [desktop apps only]
Target Platform	Windows
Header	iphlpapi.h
Library	Iphlpapi.lib
DLL	Iphlpapi.dll