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

Функция MprAdminInterfaceUpdateRoutes (mprapi.h)

  • Статья

Функция MprAdminInterfaceUpdateRoutes запрашивает указанный диспетчер маршрутизатора для обновления сведений о маршрутизации для указанного интерфейса.

Синтаксис

DWORD MprAdminInterfaceUpdateRoutes(
  [in] MPR_SERVER_HANDLE hMprServer,
  [in] HANDLE            hInterface,
  [in] DWORD             dwProtocolId,
  [in] HANDLE            hEvent
);

Параметры

[in] hMprServer

Обработка маршрутизатора, на котором обновляется информация. Получите этот дескриптор, вызвав MprAdminServerConnect.

[in] hInterface

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

[in] dwProtocolId

Значение DWORD , указывающее, какой диспетчер маршрутизатора обновляет сведения о маршрутизации. Маршрутизатор использует отдельный диспетчер маршрутизатора для каждого транспортного протокола. Допустимые значения для dwTransportId перечислены в следующей таблице.

Значение Транспорт (семейство протоколов)
PID_ATALK Appletalk
PID_IP Интернет-протокол версии 4
PID_IPX Обмен пакетами через Интернет
PID_NBF Протокол кадров NetBIOS
PID_IPV6 Windows Server 2008 или более поздней версии: протокол Internet Protocol версии 6

[in] hEvent

Обработка события, которое подается при завершении попытки обновить сведения о маршрутизации для указанного интерфейса. Если значение РАВНО NULL, функция является синхронной. Вызывающее приложение должно указать значение NULL для этого параметра, если hMprServer указывает удаленный маршрутизатор.

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

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

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

Значение Значение
ERROR_ACCESS_DENIED
 Вызывающее приложение не имеет достаточных привилегий.
ERROR_INTERFACE_NOT_CONNECTED
 Указанный интерфейс не подключен. Таким образом, маршруты не могут быть обновлены.
ERROR_INVALID_HANDLE
 Недопустимое значение hInterface .
ERROR_NO_SUCH_INTERFACE
 Указанный транспорт не выполняется в указанном интерфейсе.
ERROR_UNKNOWN_PROTOCOL_ID
 Значение dwTransportId не соответствует ни одному из диспетчеров маршрутизаторов.
ERROR_UPDATE_IN_PROGRESS
 В этом интерфейсе уже выполняется операция обновления сведений о маршрутизации.
ОЖИДАЮЩИЕ
 Интерфейс находится в процессе обновления сведений о маршрутизации. Вызывающее приложение должно ожидать объекта события, указанного hEvent. После передачи сигнала о событии состояние операции обновления можно получить, вызвав MprAdminInterfaceQueryUpdateResult.

Комментарии

Параметр dwTransportId указывает как транспортный протокол, так и уникальный диспетчер маршрутизаторов, так как маршрутизатор использует разные диспетчеры маршрутизаторов для каждого транспорта.

Требования

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

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

MprAdminInterfaceCreate

MprAdminInterfaceQueryUpdateResult

MprAdminServerConnect

Функции администрирования маршрутизатора

Справочник по управлению маршрутизаторами