Поделиться через

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

  • Статья

Функция RtmGetDestInfo возвращает сведения о назначении.

Синтаксис

DWORD RtmGetDestInfo(
  [in]  RTM_ENTITY_HANDLE RtmRegHandle,
  [in]  RTM_DEST_HANDLE   DestHandle,
  [in]  ULONG             ProtocolId,
  [in]  RTM_VIEW_SET      TargetViews,
  [out] PRTM_DEST_INFO    DestInfo
);

Параметры

[in] RtmRegHandle

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

[in] DestHandle

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

[in] ProtocolId

Указывает идентификатор протокола. ProtocolID не является частью условий поиска. Диспетчер таблиц маршрутизации использует этот идентификатор для определения возвращаемых сведений о маршруте. Например, если клиент указывает идентификатор протокола RIP, возвращается лучший маршрут RIP, даже если маршрут, отличный от RIP, является лучшим маршрутом к месту назначения.

Укажите RTM_BEST_PROTOCOL возвращать маршрут независимо от того, какой протокол ему принадлежит. Укажите RTM_THIS_PROTOCOL, чтобы вернуть оптимальный маршрут для протокола вызова.

[in] TargetViews

Указывает представления, из которых возвращаются сведения. Если клиент указывает RTM_VIEW_MASK_ANY, сведения о назначении возвращаются из всех представлений; однако сведения, относящиеся к представлению, не возвращаются.

[out] DestInfo

На входных данных DestInfo является указателем на структуру RTM_DEST_INFO .

В выходных данных DestInfo заполняется запрошенными сведениями о назначении.

Возвращаемое значение

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

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

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

Комментарии

Структура, на которую указывает DestInfo , представляет собой структуру переменной величины. Если клиент указывает несколько представлений с TargetViews, размер DestInfo увеличивается для каждого представления. Используйте макрос RTM_SIZE_OF_DEST_INFO , чтобы определить, насколько велика структура DestInfo для выделения перед вызовом этой функции. Используйте значение, указанное для TargetViews , в качестве параметра для RTM_SIZE_OF_DEST_INFO.

Используйте RtmReleaseDestInfo , чтобы освободить буфер DestInfo .

Требования

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

См. также раздел

RTM_DEST_INFO

RtmReleaseDestInfo