RTM_SIZE_OF_ROUTE_INFO macro (rtmv2.h)

The RTM_SIZE_OF_ROUTE_INFO macro returns the size of the route information structure, RTM_ROUTE_INFO. The size of this structure is variable, and is based on the number of next hops associated with the route. Use this macro when allocating memory for route structures.

Syntax

ULONG RTM_SIZE_OF_ROUTE_INFO(
     NumHops
);

Parameters

NumHops

Specifies the number of next hops in the route structure.

Return value

Type: ULONG

The return value is the size of the route information structure with the specified number of next hops.

Remarks

If the client only allocates one next hop per route, the client can allocate an RTM_ROUTE_INFO structure statically.

The macro is defined as follows:

#include <windows.h>

#define RTM_SIZE_OF_ROUTE_INFO(NumHops)                     \
    FIELD_OFFSET(RTM_ROUTE_INFO, NextHopsList.NumNextHops)

#define RTM_BASIC_ROUTE_INFO_SIZE                           \
    (RTM_BASIC_ROUTE_INFO_SIZE + (NumHops) *                \
     sizeof(RTM_NEXTHOP_HANDLE))

Requirements

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