Функция DeleteIpForwardEntry2

Функция DeleteIpForwardEntry2 удаляет запись IP-маршрута на локальном компьютере.

Синтаксис

NETIOAPI_API DeleteIpForwardEntry2(
  _In_ const MIB_IPFORWARD_ROW2 *Row
);

Параметры

• строк [in]
  Указатель на запись структуры MIB_IPFORWARD_ROW2 для записи IP-маршрута. При успешном возврате эта запись удаляется.

Возвращаемое значение

DeleteIpForwardEntry2 возвращает STATUS_SUCCESS, если функция выполнена успешно.

Если функция завершается ошибкой, DeleteIpForwardEntry2 возвращает один из следующих кодов ошибок:

Возвращаемый код	Описание
STATUS_INVALID_PARAMETER	Недопустимый параметр был передан функции. Эта ошибка возвращается, если указатель NULL передается в параметре row, элемент DestinationPrefix структуры MIB_IPFORWARD_ROW2, на которую не указан параметр строки, не указан член следующегоhop структуры MIB_IPFORWARD_ROW2, или как InterfaceLuid, так и InterfaceIndex члены структуры MIB_IPFORWARD_ROW2 были не указаны.
STATUS_NOT_FOUND	Не удалось найти указанный интерфейс. Эта ошибка возвращается, если функция не может найти сетевой интерфейс, указанный InterfaceLuid или InterfaceIndex член структуры MIB_IPFORWARD_ROW2 , на которую указывает параметр строки.
STATUS_NOT_SUPPORTED	Запрос не поддерживается. Эта ошибка возвращается, если на локальном компьютере не расположен стек IPv4, а адрес IPv4 указан в элементе Адрес структуры MIB_IPFORWARD_ROW2, на которую указывает параметр строка, или если на локальном компьютере не указан стек IPv6, а адрес IPv6 указан в элементе Адрес.
Другие	Используйте функцию FormatMessage, чтобы получить строку сообщения для возвращаемой ошибки.

Замечания

Функция DeleteIpForwardEntry2 используется для удаления записи структуры MIB_IPFORWARD_ROW2.

При входе драйвер должен инициализировать следующие элементы структуры MIB_IPFORWARD_ROW2, на которые указывает параметр строк.

• НазначениеPrefix
  Задайте допустимый префикс и семейство адресов IPv4 или IPv6.

• NextHop
  Задайте допустимый IPv4-адрес и семейство IPv6.

• InterfaceLuid или InterfaceIn dex
  Эти члены используются в порядке, указанном ранее. Поэтому если указан InterfaceLuid, этот элемент используется для определения интерфейса. Если для элемента InterfaceLuid не задано значение (значение этого элемента было равно нулю), элемент InterfaceIndex используется для определения интерфейса.

При успешном вызове DeleteIpForwardEntry2 удаляет запись IP-маршрута.

Функция DeleteIpForwardEntry2 завершается ошибкой, если destinationPrefix и члены структуры MIB_IPFORWARD_ROW2 NextHo p, указывающие параметром Row, не совпадают с существующей записью IP-маршрута в интерфейсе, указанном в InterfaceLuid или InterfaceIndex.

Драйвер может вызвать функцию GetIpForwardTable2 для перечисления записей IP-маршрутов на локальном компьютере.

Требования

Целевая платформа	универсальные
Версия	Доступно в Windows Vista и более поздних версиях операционных систем Windows.
Заголовок	Netioapi.h (include Netioapi.h)
Библиотека	Netio.lib
IRQL	< DISPATCH_LEVEL

См. также

CreateIpForwardEntry2

GetBestRoute2

GetIpForwardEntry2

GetIpForwardTable2

InitializeIpForwardEntry

MIB_IPFORWARD_ROW2

MIB_IPFORWARD_TABLE2

NotifyRouteChange2

SetIpForwardEntry2