Функция RtmIsBestRoute (rtmv2.h)

Функция RtmIsBestRoute возвращает набор представлений, в которых указанный маршрут является лучшим маршрутом к месту назначения.

Синтаксис

DWORD RtmIsBestRoute(
  [in]  RTM_ENTITY_HANDLE RtmRegHandle,
  [in]  RTM_ROUTE_HANDLE  RouteHandle,
  [out] PRTM_VIEW_SET     BestInViews
);

[in] RtmRegHandle

Дескриптор клиента, полученного из предыдущего вызова RtmRegisterEntity.

[in] RouteHandle

Дескриптор маршрута для проверка.

[out] BestInViews

Получает указатель на набор представлений, для которых указанный маршрут является лучшим маршрутом.

Если функция выполняется успешно, возвращаемое значение будет NO_ERROR.

Если функция завершается сбоем, возвращаемое значение представляет собой один из следующих кодов ошибок.

Значение	Значение
ERROR_INVALID_HANDLE	Дескриптор недействителен.

Требование	Значение
Минимальная версия клиента	Ни одна версия не поддерживается
Минимальная версия сервера	Windows 2000 Server [только классические приложения]
Целевая платформа	Windows
Header	rtmv2.h
Библиотека	Rtm.lib
DLL	Rtm.dll