ValidateRoute callback function

The routing protocol calls the ValidateRoute function to set the route preference and perform other route validation.

Syntax

DWORD WINAPI ValidateRoute(
  _In_ DWORD ProtocolId,
  _In_ PVOID RouteInfo,
  _In_ PVOID DestAddress
);

Parameters

  • ProtocolId [in]
    Specifies the identifier of the routing protocol that makes the call.

  • RouteInfo [in]
    Pointer to information that describes the route to validate.

  • DestAddress [in]
    Pointer to information that describes the destination address. This parameter is optional and can be NULL.

Return value

If the function succeeds, the return value is NO_ERROR.

If the function fails, the return value is one of the following error codes.

Value Meaning
ERROR_INVALID_PARAMETER

The some or all of the information specified by the RouteInfo or DestAddress parameters is invalid.

Other

The call failed. Use FormatMessage to retrieve the error message that corresponds to the returned error code.

 

 

Requirements

Minimum supported client

None supported

Minimum supported server

Windows 2000 Server [desktop apps only]

Header

Routprot.h

See also

Protocol Identifiers