CancelMibChangeNotify2 (Compact 2013)

  • Article

3/26/2014

This function deregisters for change notifications 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
    The handle returned from a notification registration or retrieval function to indicate which notification to cancel.

Return Value

If the function succeeds, the return value is NO_ERROR.

If the function fails, the return value is one of the following error codes.

Return code

Description

ERROR_INVALID_PARAMETER

An invalid parameter was passed to the function. This error is returned if the NotificationHandle parameter was a NULL pointer.

Other

Use FormatMessage to obtain the message string for the returned error.

Remarks

The CancelMibChangeNotify2 function deregisters for a change notification previously requested for IP interface changes, IP address changes, or IP route changes on a local device. 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 device. This request is made by calling the NotifyStableUnicastIpAddressTable function.

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

See Also

Reference

IP Helper Functions
NotifyIpInterfaceChange
NotifyRouteChange2
NotifyStableUnicastIpAddressTable
NotifyUnicastIpAddressChange