CancelMibChangeNotify2 function

Article
03/03/2023

The CancelMibChangeNotify2 function deregisters a driver change notification for IP interface changes, IP address changes, IP route changes, and requests to retrieve the stable Unicast IP address table.

Syntax

NETIOAPI_API CancelMibChangeNotify2(
  _In_ HANDLE NotificationHandle
);

Parameters

NotificationHandle [in]
The handle that is returned from a notification registration or retrieval function to indicate which notification to cancel.

Return value

CancelMibChangeNotify2 returns STATUS_SUCCESS if the function succeeds.

If the function fails, CancelMibChangeNotify2 returns one of the following error codes:

Return code	Description
STATUS_INVALID_PARAMETER	An invalid parameter was passed to the function. CancelMibChangeNotify2 returns this error if the NotificationHandle parameter was a NULL pointer.
Other	Use the FormatMessage function to obtain the message string for the returned error.

Remarks

The CancelMibChangeNotify2 function deregisters a driver change notification previously requested for IP interface changes, IP address changes, or IP route changes on a local computer. These requests are made by calling NotifyIpInterfaceChange, NotifyRouteChange2, or NotifyUnicastIpAddressChange. The CancelMibChangeNotify2 function also cancels a previous request to retrieve the stable unicast IP address table on a local computer. This request is made by calling the NotifyStableUnicastIpAddressTable function.

The NotificationHandle parameter that is returned to these notification functions is passed to CancelMibChangeNotify2 to deregister driver change notifications or to cancel a pending request to retrieve the stable unicast IP address table.

Requirements

Target platform	Universal
Version	Available in Windows Vista and later versions of the Windows operating systems.
Header	Netioapi.h (include Netioapi.h)
Library	Netio.lib
IRQL	PASSIVE_LEVEL