Функция DeleteIpForwardEntry2
Функция DeleteIpForwardEntry2 удаляет запись IP-маршрута на локальном компьютере.
Синтаксис
NETIOAPI_API DeleteIpForwardEntry2(
_In_ const MIB_IPFORWARD_ROW2 *Row
);
Параметры
- Строка [в]
Указатель на запись структуры MIB_IPFORWARD_ROW2 для записи IP-маршрута. При успешном возвращении эта запись удаляется.
Возвращаемое значение
DeleteIpForwardEntry2 возвращает STATUS_SUCCESS, если функция выполнена успешно.
Если функция завершается ошибкой, DeleteIpForwardEntry2 возвращает один из следующих кодов ошибок:
| Код возврата | Описание |
|---|---|
| STATUS_INVALID_PARAMETER | В функцию передан недопустимый параметр. Эта ошибка возвращается, если в параметре Row передан указатель NULL, элемент DestinationPrefixструктуры MIB_IPFORWARD_ROW2, на которую указывает параметр Row, не был указан, не был указан элемент NextHop структуры MIB_IPFORWARD_ROW2 или элементы InterfaceLuid и InterfaceIndex структуры MIB_IPFORWARD_ROW2 были не указаны. |
| STATUS_NOT_FOUND | Не удалось найти указанный интерфейс. Эта ошибка возвращается, если функции не удается найти сетевой интерфейс, заданный элементом InterfaceLuid или InterfaceIndex структуры MIB_IPFORWARD_ROW2, на которую указывает параметр Row . |
| STATUS_NOT_SUPPORTED | Запрос не поддерживается. Эта ошибка возвращается, если на локальном компьютере не расположен стек IPv4 и IPv4-адрес был указан в элементе Адрес структуры MIB_IPFORWARD_ROW2, на которую указывает параметр Row , или если на локальном компьютере не расположен стек IPv6, а в элементе Address указан IPv6-адрес. |
| Другое | Используйте функцию FormatMessage , чтобы получить строку сообщения для возвращаемой ошибки. |
Комментарии
Функция DeleteIpForwardEntry2 используется для удаления записи структуры MIB_IPFORWARD_ROW2 .
На входных данных драйвер должен инициализировать следующие элементы структуры MIB_IPFORWARD_ROW2, на которую указывает параметр Row .
DestinationPrefix
Задайте допустимый префикс И семейство адресов IPv4 или IPv6.NextHop
Задайте допустимый адрес IPv4 или IPv6 и семейство.InterfaceLuid или InterfaceIndex
Эти элементы используются в порядке, указанном ранее. Поэтому если указан InterfaceLuid , этот член используется для определения интерфейса. Если для элемента InterfaceLuid не задано значение (значение этого элемента было равно нулю), далее для определения интерфейса используется элемент InterfaceIndex .
В выходных данных при успешном вызове DeleteIpForwardEntry2 удаляет запись IP-маршрута.
Функция DeleteIpForwardEntry2 завершается сбоем, если элементы DestinationPrefix и NextHop структуры MIB_IPFORWARD_ROW2, на которую указывает параметр Row , не соответствуют существующей записи IP-маршрута в интерфейсе, указанном в элементах InterfaceLuid или InterfaceIndex .
Драйвер может вызвать функцию GetIpForwardTable2 для перечисления записей IP-маршрутов на локальном компьютере.
Требования
Целевая платформа |
Универсальное |
Версия |
Доступно в Windows Vista и более поздних версиях операционных систем Windows. |
Заголовок |
Netioapi.h (включая Netioapi.h) |
Библиотека |
Netio.lib |
IRQL |
< DISPATCH_LEVEL |