Share via

CancelMibChangeNotify2 (NETIOAPI) (Compact 7)

  • Article

3/12/2014

This 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
    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:

Error Code Meaning

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 device. These requests are made by calling NotifyIpInterfaceChange (NETIOAPI), NotifyRouteChange2 (NETIOAPI), or NotifyUnicastIpAddressChange (NETIOAPI). 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 (NETIOAPI) function.

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

See Also

Reference

IP Helper Kernel-Mode Functions
NotifyIpInterfaceChange (NETIOAPI)
NotifyRouteChange2 (NETIOAPI)
NotifyStableUnicastIpAddressTable (NETIOAPI)
NotifyUnicastIpAddressChange (NETIOAPI)