PGET_INTERFACE_INFO функция обратного вызова (routprot.h)

Статья
03/15/2023

Функция GetInterfaceInfo получает сведения о конфигурации, хранящиеся протоколом маршрутизации для определенного интерфейса.

Синтаксис

PGET_INTERFACE_INFO PgetInterfaceInfo;

DWORD PgetInterfaceInfo(
  [in]      ULONG InterfaceIndex,
  [in]      PVOID InterfaceInfo,
  [in, out] PULONG BufferSize,
  [in]      PULONG StructureVersion,
  [in]      PULONG StructureSize,
  [in]      PULONG StructureCount
)
{...}

Параметры

[in] InterfaceIndex

Указывает интерфейс в наборе интерфейсов, настроенных на маршрутизаторе.

[in] InterfaceInfo

Указатель на буфер, который получает определяемые протоколом сведения о конфигурации, связанные с интерфейсом. Эти сведения являются частными для протокола маршрутизации.

[in, out] BufferSize

Указатель на переменную DWORD .

При входе: эта переменная определяет размер буфера, предоставленного для получения сведений о конфигурации, в байтах.

На выходе: эта переменная получает размер данных, помещенных в буфер, в байтах. Если начальный размер был недостаточно велик, эта переменная содержит размер, необходимый для хранения всех данных.

[in] StructureVersion

Указывает версию информационных структур, на которые указывает параметр InterfaceInfo . В некоторых случаях это значение равно версии протокола маршрутизации.

[in] StructureSize

Задает размер каждой информационной структуры, на которую указывает параметр InterfaceInfo . Так как некоторые информационные структуры содержат элементы переменной длины, протокол маршрутизации не обязательно может определить размер сведений из версии.

[in] StructureCount

Указывает количество информационных структур, на которые указывает параметр InterfaceInfo . Этот параметр всегда является одним.

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

Если функция выполняется успешно, возвращаемое значение будет NO_ERROR.

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

Значение	Описание
ERROR_CAN_NOT_COMPLETE	Попытка получить сведения завершилась сбоем.
ERROR_INVALID_PARAMETER	Недопустимый параметр InterfaceIndex (например, не существует интерфейса с этим индексом) или параметр InterfaceInfoSize имеет значение NULL.
ERROR_INSUFFICIENT_BUFFER	Размер предоставленного выходного буфера недостаточно велик для хранения запрошенной информации. Требуемый размер возвращается в переменной DWORD , на которую указывает InterfaceInfoSize.

Требования

Требование	Значение
Минимальная версия клиента	Ни одна версия не поддерживается
Минимальная версия сервера	Windows 2000 Server [только классические приложения]
Целевая платформа	Windows
Header	routprot.h

См. также раздел

Функции интерфейса протокола маршрутизации

Справочник по интерфейсу протокола маршрутизации

SetInterfaceInfo

Поделиться через