StartProtocol

[This is preliminary documentation and subject to change.]

The StartProtocol function initializes the routing protocol's functionality. The router manager uses this function to pass the routing protocol global configuration parameters and a set of API entry points. The protocol uses these entry points to call into the router manager.

DWORD StartProtocol(
  HANDLE NotificationEvent,
                    // handle to an event object
  PSUPPORT_FUNCTIONS SupportFunctions,
                    // address of SUPPORT_FUNCTIONS structure
  PVOID GlobalInfo  // address of configuration information
);
 

Parameters

NotificationEvent

Handle to an event object. The routing protocol will signal this event when it wants the router manager to retrieve an asynchronous message from the queue maintained by the protocol.

SupportFunctions

Pointer to a SUPPORT_FUNCTIONS structure. The fields of this structure are pointers to functions in the router manager. These functions allow the protocol to access information that spans routing protocols.

GlobalInfo

Pointer to protocol-defined global (as opposed to interface specific) configuration information. This information is private to the routing protocol.

Return Values

NO_ERROR

The routing protocol initialized successfully and is ready to receive interface information.

ERROR_CAN_NOT_COMPLETE

The attempt to initialize the routing protocol failed.

ERROR_INVALID_PARAMETER

One of the parameters pointed to by the GlobalInfo parameter is invalid.

QuickInfo

  Windows NT: Use version 5.0 and later.
  Windows: Unsupported.
  Windows CE: Unsupported.
  Header: Declared in routprot.h.
  Import Library: user-defined.

See Also

GetEventMessage, StartProtocol Sample, StopProtocol, SUPPORT_FUNCTIONS