RTM_SIZE_OF_DEST_INFO macro (rtmv2.h)

Article
06/24/2021

The RTM_SIZE_OF_DEST_INFO macro returns the size of the destination information structure (RTM_DEST_INFO). The size of this structure is variable, and is based on the number of views for which it contains information. Use this macro when allocating memory for destination information.

Syntax

void RTM_SIZE_OF_DEST_INFO(
   NumViews
);

Parameters

NumViews

Specifies the number of views in the destination structure.

Return value

None

Remarks

If the client only uses one view per destination, the client can allocate an RTM_DEST_INFO structure statically.

The macro is defined as follows:

#include <windows.h>

#define RTM_DEST_VIEW_INFO_SIZE                             \
    FIELD_OFFSET(RTM_DEST_INFO, ViewInfo)

#define RTM_SIZE_OF_DEST_INFO(NumViews)                     \
    (sizeof(RTM_DEST_INFO) - RTM_BASIC_DEST_INFO_SIZE)

#define RTM_BASIC_DEST_INFO_SIZE                            \
    (RTM_BASIC_DEST_INFO_SIZE + (NumViews) *                \
    RTM_DEST_VIEW_INFO_SIZE)

Requirements

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

Share via