PSTOP_PROTOCOL callback function (routprot.h)

The StopProtocol function causes the routing protocol to perform an orderly shutdown.

Syntax

PSTOP_PROTOCOL PstopProtocol;

DWORD PstopProtocol()
{...}

Parameters

This callback function has no parameters.

Return value

If the routing protocol shutdown successfully (synchronous completion), the return value is NO_ERROR.

If routing protocol is shutting down asynchronously, the return value is ERROR_PROTOCOL_STOP_PENDING. In this case, the protocol reports the results of the shutdown through the event message queue.

Requirements

Requirement Value
Minimum supported client None supported
Minimum supported server Windows 2000 Server [desktop apps only]
Target Platform Windows
Header routprot.h

See also

GetEventMessage

Routing Protocol Interface Functions

Routing Protocol Interface Reference

StartProtocol