Función NotifyRouteChange2
La función NotifyRouteChange2 registra el controlador para recibir una notificación de cambios en las entradas de ruta IP en un equipo local.
Sintaxis
NETIOAPI_API NotifyRouteChange2(
_In_ ADDRESS_FAMILY Family,
_In_ PIPFORWARD_CHANGE_CALLBACK Callback,
_In_ PVOID CallerContext,
_In_ BOOLEAN InitialNotification,
_Inout_ HANDLE *NotificationHandle
);
Parámetros
Familia [in]
Familia de direcciones en la que se va a registrar el controlador para recibir notificaciones de cambio.Los valores posibles para la familia de direcciones se enumeran en el archivo de encabezado Winsock2.h. Tenga en cuenta que los valores de la familia de direcciones AF_ y las constantes de familia de protocolos de PF_ son idénticas (por ejemplo, AF_INET y PF_INET), por lo que puede usar cualquiera de las constantes.
En Windows Vista y versiones posteriores de los sistemas operativos Windows, los valores posibles para el parámetro Family se definen en el archivo de encabezado Ws2def.h. Tenga en cuenta que el archivo de encabezado Ws2def.h se incluye automáticamente en Netioapi.h y nunca debe usar Ws2def.h directamente.
Actualmente se admiten los siguientes valores para la familia de direcciones:
AF_INET
Familia de direcciones IPv4. Cuando se especifica este valor, esta función registra el controlador solo para las notificaciones de cambio de ruta IPv4.AF_INET6
Familia de direcciones IPv6. Cuando se especifica este valor, esta función registra el controlador solo para las notificaciones de cambio de ruta IPv6.AF_UNSPEC
No se especifica la familia de direcciones. Cuando se especifica este valor, esta función registra el controlador para las notificaciones de cambio de ruta IPv4 e IPv6.
Devolución de llamada [in]
Puntero a la función que se va a llamar cuando se produce un cambio. Se llama a esta función cuando se recibe una notificación de interfaz.CallerContext [in]
Contexto de usuario que se pasa a la función de devolución de llamada especificada en el parámetro Callback cuando se recibe una notificación de interfaz.InitialNotification [in]
Valor que indica si la devolución de llamada se debe invocar inmediatamente después de que se complete el registro para la notificación de cambio. Esta notificación inicial no indica que se ha producido un cambio en la ruta IP. El propósito de este parámetro para proporcionar confirmación de que la devolución de llamada está registrada.NotificationHandle [in, out]
Puntero a una estructura de MIB_IPINTERFACE_ROW que se va a inicializar. Si la devolución se realiza correctamente, los miembros de esta estructura se inicializan con información predeterminada para una interfaz en el equipo local.
Valor devuelto
NotifyRouteChange2 devuelve STATUS_SUCCESS si la función se realiza correctamente.
Si se produce un error en la función, NotifyRouteChange2 devuelve uno de los siguientes códigos de error.
| Código devuelto | Descripción |
|---|---|
| ERROR_INVALID_HANDLE | Error interno en el que se encontró un identificador no válido. |
| STATUS_INVALID_PARAMETER | Se pasó un parámetro no válido a la función. Este error se devuelve si el parámetro Family no se AF_INET, AF_INET6 o AF_UNSPEC. |
| STATUS_NOT_ENOUGH_MEMORY | No había memoria suficiente. |
| Otros | Use la función FormatMessage para obtener la cadena de mensaje para el error devuelto. |
Observaciones
El controlador debe establecer el parámetro Family en AF_INET, AF_INET6 o AF_UNSPEC.
La invocación de la función de devolución de llamada especificada en el parámetro Callback se serializa. La función de devolución de llamada debe definirse como una función de tipo VOID. Los parámetros que se pasan a la función de devolución de llamada incluyen lo siguiente.
| Parámetro | Descripción |
|---|---|
IN PVOID CallerContext |
El parámetro CallerContext que se pasa a la función NotifyRouteChange2 cuando registra el controlador para las notificaciones de cambio. |
IN PMIB_IPFORWARD_ROW2 Fila OPCIONAL |
Puntero a la entrada de MIB_IPFORWARD_ROW2 para la entrada de ruta IP que se cambió. Este parámetro es un puntero NULL cuando el valor de MIB_NOTIFICATION_TYPE que se pasa en el parámetro NotificationType a la función de devolución de llamada se establece en MibInitialNotification. Esta situación solo puede producirse si el parámetro InitialNotification que se pasa a NotifyRouteChange2 se estableció en TRUE al registrar el controlador para las notificaciones de cambio. |
IN MIB_NOTIFICATION_TYPE NotificationType |
Tipo de notificación. Este miembro puede ser uno de los valores del tipo de enumeración MIB_NOTIFICATION_TYPE . |
Para anular el registro del controlador para las notificaciones de cambio, llame a la función CancelMibChangeNotify2 y pase el parámetro NotificationHandle que NotifyRouteChange2 devuelve.
Requisitos
Plataforma de destino |
Universal |
Versión |
Disponible en Windows Vista y versiones posteriores de los sistemas operativos Windows. |
Encabezado |
Netioapi.h (incluya Netioapi.h) |
Biblioteca |
Netio.lib |
IRQL |
< DISPATCH_LEVEL |