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

Статья
03/05/2024

Функция StartProtocol инициализирует функциональные возможности протокола маршрутизации. Диспетчер маршрутизатора использует эту функцию для передачи глобальных параметров конфигурации протокола маршрутизации и набора точек входа API. Протокол использует эти точки входа для вызова диспетчера маршрутизатора.

Синтаксис

PSTART_PROTOCOL PstartProtocol;

DWORD PstartProtocol(
  [in] HANDLE NotificationEvent,
  [in] PSUPPORT_FUNCTIONS SupportFunctions,
  [in] LPVOID GlobalInfo,
  [in] ULONG StructureVersion,
  [in] ULONG StructureSize,
  [in] ULONG StructureCount
)
{...}

Параметры

[in] NotificationEvent

Дескриптор объекта события. Протокол маршрутизации сигнализирует об этом событии, когда он хочет, чтобы диспетчер маршрутизатора извлек асинхронное сообщение из очереди, поддерживаемой протоколом.

[in] SupportFunctions

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

[in] GlobalInfo

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

[in] StructureVersion

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

[in] StructureSize

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

[in] StructureCount

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

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

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

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

Значение	Описание
ERROR_CAN_NOT_COMPLETE	Не удалось инициализировать протокол маршрутизации.
ERROR_INVALID_PARAMETER	Один из параметров, на который указывает параметр GlobalInfo , является недопустимым.

Требования

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

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

GetEventMessage

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

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

SUPPORT_FUNCTIONS

StopProtocol