Функция GetIpForwardTable2
Функция GetIpForwardTable2 извлекает записи IP-маршрута на локальном компьютере.
Синтаксис
NETIOAPI_API GetIpForwardTable2(
_In_ ADDRESS_FAMILY Family,
_Out_ PMIB_IPFORWARD_TABLE2 *Table
);
Параметры
Family [in]
Извлекаемая семья адресов.Возможные значения для семейства адресов перечислены в файле заголовка Winsock2.h. Обратите внимание, что значения для семейства адресов AF_ и констант семейства PF_ протоколов идентичны (например, AF_INET и PF_INET), поэтому можно использовать обе константы.
В Windows Vista и более поздних версиях операционных систем Windows возможные значения параметра Family определяются в файле заголовка Ws2def.h. Обратите внимание, что файл заголовка Ws2def.h автоматически включается в Netioapi.h, и никогда не следует использовать Ws2def.h напрямую.
В настоящее время для семейства адресов поддерживаются следующие значения:
AF_INET
Семейство адресов IPv4. Если указано это значение, эта функция возвращает таблицу IP-маршрутизации, содержащую только записи IPv4.AF_INET6
Семейство адресов IPv6. Если это значение указано, эта функция возвращает таблицу IP-маршрутизации, содержащую только записи IPv6.AF_UNSPEC
Семейство адресов не указано. Если это значение указано, эта функция возвращает таблицу IP-маршрутизации, содержащую записи IPv4 и IPv6.
Таблица [out]
Указатель на структуру MIB_IPFORWARD_TABLE2 , содержащую таблицу записей IP-маршрутов на локальном компьютере.
Возвращаемое значение
GetIpForwardTable2 возвращает STATUS_SUCCESS, если функция выполнена успешно.
В случае сбоя функции GetIpForwardTable2 возвращает один из следующих кодов ошибок:
| Код возврата | Описание |
|---|---|
| STATUS_INVALID_PARAMETER | В функцию передан недопустимый параметр. Эта ошибка возвращается, если в параметре Table передается указатель NULL или параметр Family не указан как AF_INET, AF_INET6 или AF_UNSPEC. |
| STATUS_NOT_ENOUGH_MEMORY | Недостаточно ресурсов памяти для завершения операции. |
| STATUS_NOT_FOUND | Записи IP-маршрута, указанные в параметре Family , не найдены. |
| STATUS_NOT_SUPPORTED | Запрос не поддерживается. Эта ошибка возвращается, если на локальном компьютере не расположен стек IPv4 и AF_INET был указан в параметре Family , или если на локальном компьютере не расположен стек IPv6 и AF_INET6 был указан в параметре Family . Эта ошибка также возвращается в версиях Windows, в которых эта функция не поддерживается. |
| Другое | Используйте функцию FormatMessage , чтобы получить строку сообщения для возвращаемой ошибки. |
Комментарии
Функция GetIpForwardTable2 перечисляет записи IP-маршрута на локальном компьютере и возвращает эти сведения в MIB_IPFORWARD_TABLE2 структуре.
Записи IP-маршрута возвращаются в MIB_IPFORWARD_TABLE2 структуре в буфере, на которую указывает параметр Table . Структура MIB_IPFORWARD_TABLE2 содержит число записей IP-маршрутов и массив MIB_IPFORWARD_ROW2 структур для каждой записи IP-маршрута. Если эти возвращаемые структуры больше не требуются, драйвер должен освободить память, вызвав FreeMibTable.
Драйвер должен инициализировать параметр Family для AF_INET, AF_INET6 или AF_UNSPEC.
Обратите внимание, что возвращаемая MIB_IPFORWARD_TABLE2 структура, на которую указывает параметр Table , может содержать заполнение для выравнивания между элементом NumEntries и первой записью массива MIB_IPFORWARD_ROW2 в элементе Table структуры MIB_IPFORWARD_TABLE2. Между MIB_IPFORWARD_ROW2 записями массива также может присутствовать заполнение для выравнивания. Любой доступ к записи массива MIB_IPFORWARD_ROW2 должен предполагать наличие заполнения.
Требования
Целевая платформа |
Универсальное |
Версия |
Доступно в Windows Vista и более поздних версиях операционных систем Windows. |
Заголовок |
Netioapi.h (включая Netioapi.h) |
Библиотека |
Netio.lib |
IRQL |
< DISPATCH_LEVEL |