Función DeleteIpForwardEntry2
La función DeleteIpForwardEntry2 elimina una entrada de ruta IP en un equipo local.
Sintaxis
NETIOAPI_API DeleteIpForwardEntry2(
_In_ const MIB_IPFORWARD_ROW2 *Row
);
Parámetros
- Fila [in]
Puntero a una entrada de estructura MIB_IPFORWARD_ROW2 para una entrada de ruta IP. Si la devolución es correcta, se elimina esta entrada.
Valor devuelto
DeleteIpForwardEntry2 devuelve STATUS_SUCCESS si la función se realiza correctamente.
Si se produce un error en la función, DeleteIpForwardEntry2 devuelve uno de los siguientes códigos de error:
| Código devuelto | Descripción |
|---|---|
| STATUS_INVALID_PARAMETER | Se pasó un parámetro no válido a la función. Este error se devuelve si se pasa un puntero NULL en el parámetro Row , el miembro DestinationPrefix de la estructura MIB_IPFORWARD_ROW2 a la que no se especificó el parámetro Row , no se especificó el miembro NextHop de la estructura MIB_IPFORWARD_ROW2, o no se especificaron los miembros InterfaceLuid e InterfaceIndex de la estructura MIB_IPFORWARD_ROW2. |
| STATUS_NOT_FOUND | No se encontró la interfaz especificada. Este error se devuelve si la función no encuentra la interfaz de red especificada por el miembro InterfaceLuid o InterfaceIndex de la estructura MIB_IPFORWARD_ROW2 a la que apunta el parámetro Row . |
| STATUS_NOT_SUPPORTED | No se admite la solicitud. Este error se devuelve si no se encuentra ninguna pila IPv4 en el equipo local y se especificó una dirección IPv4 en el miembro Address de la estructura MIB_IPFORWARD_ROW2 a la que apunta el parámetro Row , o si no se encuentra ninguna pila IPv6 en el equipo local y se especificó una dirección IPv6 en el miembro Address . |
| Otros | Use la función FormatMessage para obtener la cadena de mensaje del error devuelto. |
Observaciones
La función DeleteIpForwardEntry2 se usa para eliminar una entrada de estructura MIB_IPFORWARD_ROW2 .
En la entrada, el controlador debe inicializar los siguientes miembros de la estructura MIB_IPFORWARD_ROW2 a la que apunta el parámetro Row .
DestinationPrefix
Establézcalo en un prefijo y familia de direcciones IPv4 o IPv6 válidos.NextHop
Establézcalo en una dirección y familia IPv4 o IPv6 válida.InterfaceLuid o InterfaceIndex
Estos miembros se usan en el orden que se muestra anteriormente. Por lo tanto, si se especifica InterfaceLuid , este miembro se usa para determinar la interfaz. Si no se estableció ningún valor para el miembro InterfaceLuid (el valor de este miembro se estableció en cero), el miembro InterfaceIndex se usa a continuación para determinar la interfaz.
En la salida, cuando la llamada se realiza correctamente, DeleteIpForwardEntry2 elimina la entrada de ruta IP.
Se produce un error en la función DeleteIpForwardEntry2 si los miembros DestinationPrefix y NextHop de la estructura MIB_IPFORWARD_ROW2 que apunta el parámetro Row no coinciden con una entrada de ruta IP existente en la interfaz especificada en los miembros InterfaceLuid o InterfaceIndex .
El controlador puede llamar a la función GetIpForwardTable2 para enumerar las entradas de ruta IP en un equipo local.
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 |