PREGISTER_PROTOCOL callback function (routprot.h)

Article
10/13/2021

The RegisterProtocol function registers the routing protocol with the router manager. It also informs the router manager of the functionality that the routing protocol supports.

Syntax

PREGISTER_PROTOCOL PregisterProtocol;

DWORD PregisterProtocol(
  [in, out] PMPR_ROUTING_CHARACTERISTICS pRoutingChar,
  [in, out] PMPR_SERVICE_CHARACTERISTICS pServiceChar
)
{...}

Parameters

[in, out] pRoutingChar

On input, pointer to an MPR_ROUTING_CHARACTERISTICS structure.

On output, receives pointers to functions implemented for the routing protocol.

See the reference page for the MPR_ROUTING_CHARACTERISTICS structure for more information on how to use it with the RegisterProtocol function.

[in, out] pServiceChar

On input, pointer to an MPR_SERVICE_CHARACTERISTICS structure.

On output, receives pointers to functions implemented for the routing protocol.

See the reference page for the MPR_SERVICE_CHARACTERISTICS structure for more information on how to use it with the RegisterProtocol function.

Return value

If the function succeeds, the return value is NO_ERROR.

If the function fails, the return value is ERROR_NOT_SUPPORTED.

Remarks

All routing protocol DLLs must fill in values for the MPR_ROUTING_CHARACTERISTICS structure.

Routing protocol DLLs that provide services must fill in values for the MPR_SERVICE_CHARACTERISTICS structure. If a routing protocol DLL does not provide services, it should fill in zero for the fSupportedFunctionality member of this structure, but need not fill in values for the other members.

Routing protocols are implemented in user-mode DLLs. A single DLL may implement multiple routing protocols. Therefore, router manager may call RegisterProtocol multiple times, once for each routing protocol implemented in the DLL.

Requirements

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