Функция GetIpForwardTable2
Функция GetIpForwardTable2 извлекает записи IP-маршрута на локальном компьютере.
Синтаксис
NETIOAPI_API GetIpForwardTable2(
_In_ ADDRESS_FAMILY Family,
_Out_ PMIB_IPFORWARD_TABLE2 *Table
);
Параметры
семья [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 | Недопустимый параметр был передан функции. Эта ошибка возвращается, если указатель 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.
Драйвер должен инициализировать параметр семейства для AF_INET, AF_INET6 или AF_UNSPEC.
Обратите внимание, что возвращаемая структура MIB_IPFORWARD_TABLE2, указывающая параметр таблицы, может содержать выравнивание между элементом NumEntries и первой записью массива MIB_IPFORWARD_ROW2 таблицы элемента структуры MIB_IPFORWARD_TABLE2. Заполнение для выравнивания также может присутствовать между записями массива MIB_IPFORWARD_ROW2. Любой доступ к записи массива MIB_IPFORWARD_ROW2 должен предполагать, что заполнение может существовать.